com.google.cloud.automl.v1

Class ModelExportOutputConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.automl.v1.ModelExportOutputConfig

All Implemented Interfaces:

ModelExportOutputConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ModelExportOutputConfig
extends com.google.protobuf.GeneratedMessageV3
implements ModelExportOutputConfigOrBuilder

 Output configuration for ModelExport Action.
 

Protobuf type google.cloud.automl.v1.ModelExportOutputConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelExportOutputConfig.Builder Output configuration for ModelExport Action.
static class	ModelExportOutputConfig.DestinationCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	GCS_DESTINATION_FIELD_NUMBER
static int	MODEL_FORMAT_FIELD_NUMBER
static int	PARAMS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
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
boolean	equals(Object obj)
static ModelExportOutputConfig	getDefaultInstance()
ModelExportOutputConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ModelExportOutputConfig.DestinationCase	getDestinationCase()
GcsDestination	getGcsDestination() Required.
GcsDestinationOrBuilder	getGcsDestinationOrBuilder() Required.
String	getModelFormat() The format in which the model must be exported.
com.google.protobuf.ByteString	getModelFormatBytes() The format in which the model must be exported.
Map<String,String>	getParams() Deprecated.
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
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
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
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
com.google.protobuf.Parser<ModelExportOutputConfig>	getParserForType()
int	getSerializedSize()
boolean	hasGcsDestination() Required.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static ModelExportOutputConfig.Builder	newBuilder()
static ModelExportOutputConfig.Builder	newBuilder(ModelExportOutputConfig prototype)
ModelExportOutputConfig.Builder	newBuilderForType()
protected ModelExportOutputConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ModelExportOutputConfig	parseDelimitedFrom(InputStream input)
static ModelExportOutputConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExportOutputConfig	parseFrom(byte[] data)
static ModelExportOutputConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExportOutputConfig	parseFrom(ByteBuffer data)
static ModelExportOutputConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExportOutputConfig	parseFrom(com.google.protobuf.ByteString data)
static ModelExportOutputConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExportOutputConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static ModelExportOutputConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExportOutputConfig	parseFrom(InputStream input)
static ModelExportOutputConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ModelExportOutputConfig>	parser()
ModelExportOutputConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_FORMAT_FIELD_NUMBER

public static final int MODEL_FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDestinationCase

public ModelExportOutputConfig.DestinationCase getDestinationCase()

Specified by:

getDestinationCase in interface ModelExportOutputConfigOrBuilder

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];

Specified by:

hasGcsDestination in interface ModelExportOutputConfigOrBuilder

Returns:

Whether the gcsDestination field is set.

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];

Specified by:

getGcsDestination in interface ModelExportOutputConfigOrBuilder

Returns:

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];

Specified by:

getGcsDestinationOrBuilder in interface ModelExportOutputConfigOrBuilder

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](https://cloud.google.com/edge-tpu/)
                    devices.
 * tf_saved_model - A tensorflow model in SavedModel format.
 * tf_js - A [TensorFlow.js](https://www.tensorflow.org/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](https://cloud.google.com/vision/automl/docs/containers-gcs-quickstart)
 * core_ml - Used for iOS mobile devices.
 

string model_format = 4;

Specified by:

getModelFormat in interface ModelExportOutputConfigOrBuilder

Returns:

The modelFormat.

getModelFormatBytes

public com.google.protobuf.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](https://cloud.google.com/edge-tpu/)
                    devices.
 * tf_saved_model - A tensorflow model in SavedModel format.
 * tf_js - A [TensorFlow.js](https://www.tensorflow.org/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](https://cloud.google.com/vision/automl/docs/containers-gcs-quickstart)
 * core_ml - Used for iOS mobile devices.
 

string model_format = 4;

Specified by:

getModelFormatBytes in interface ModelExportOutputConfigOrBuilder

Returns:

The bytes for modelFormat.

getParamsCount

public int getParamsCount()

Description copied from interface: ModelExportOutputConfigOrBuilder

 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;

Specified by:

getParamsCount in interface ModelExportOutputConfigOrBuilder

containsParams

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;

Specified by:

containsParams in interface ModelExportOutputConfigOrBuilder

getParams

@Deprecated
public Map<String,String> getParams()

Deprecated.

Use getParamsMap() instead.

Specified by:

getParams in interface ModelExportOutputConfigOrBuilder

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;

Specified by:

getParamsMap in interface ModelExportOutputConfigOrBuilder

getParamsOrDefault

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;

Specified by:

getParamsOrDefault in interface ModelExportOutputConfigOrBuilder

getParamsOrThrow

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;

Specified by:

getParamsOrThrow in interface ModelExportOutputConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ModelExportOutputConfig parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelExportOutputConfig parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelExportOutputConfig parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelExportOutputConfig parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelExportOutputConfig parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelExportOutputConfig parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelExportOutputConfig parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static ModelExportOutputConfig parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ModelExportOutputConfig parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ModelExportOutputConfig parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static ModelExportOutputConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static ModelExportOutputConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public ModelExportOutputConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ModelExportOutputConfig.Builder newBuilder()

newBuilder

public static ModelExportOutputConfig.Builder newBuilder(ModelExportOutputConfig prototype)

toBuilder

public ModelExportOutputConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ModelExportOutputConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ModelExportOutputConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<ModelExportOutputConfig> parser()

getParserForType

public com.google.protobuf.Parser<ModelExportOutputConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ModelExportOutputConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder