Class AnalyzerDefinition (0.12.0)

public final class AnalyzerDefinition extends GeneratedMessageV3 implements AnalyzerDefinitionOrBuilder

Defines an Analyzer.

An analyzer processes data from its input streams using the logic defined in the Operator that it represents. Of course, it produces data for the output streams declared in the Operator.

Protobuf type google.cloud.visionai.v1.AnalyzerDefinition

Static Fields

ANALYZER_FIELD_NUMBER

public static final int ANALYZER_FIELD_NUMBER
Field Value
Type Description
int

ATTRS_FIELD_NUMBER

public static final int ATTRS_FIELD_NUMBER
Field Value
Type Description
int

DEBUG_OPTIONS_FIELD_NUMBER

public static final int DEBUG_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

INPUTS_FIELD_NUMBER

public static final int INPUTS_FIELD_NUMBER
Field Value
Type Description
int

OPERATOR_FIELD_NUMBER

public static final int OPERATOR_FIELD_NUMBER
Field Value
Type Description
int

OPERATOR_OPTION_FIELD_NUMBER

public static final int OPERATOR_OPTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnalyzerDefinition getDefaultInstance()
Returns
Type Description
AnalyzerDefinition

getDescriptor()

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

newBuilder()

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

newBuilder(AnalyzerDefinition prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsAttrs(String key)

public boolean containsAttrs(String key)

The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

map<string, .google.cloud.visionai.v1.AttributeValue> attrs = 4;

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

getAnalyzer()

public String getAnalyzer()

The name of this analyzer.

Tentatively a-z(_[a-z0-9]+).

string analyzer = 1;

Returns
Type Description
String

The analyzer.

getAnalyzerBytes()

public ByteString getAnalyzerBytes()

The name of this analyzer.

Tentatively a-z(_[a-z0-9]+).

string analyzer = 1;

Returns
Type Description
ByteString

The bytes for analyzer.

getAttrs() (deprecated)

public Map<String,AttributeValue> getAttrs()

Use #getAttrsMap() instead.

Returns
Type Description
Map<String,AttributeValue>

getAttrsCount()

public int getAttrsCount()

The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

map<string, .google.cloud.visionai.v1.AttributeValue> attrs = 4;

Returns
Type Description
int

getAttrsMap()

public Map<String,AttributeValue> getAttrsMap()

The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

map<string, .google.cloud.visionai.v1.AttributeValue> attrs = 4;

Returns
Type Description
Map<String,AttributeValue>

getAttrsOrDefault(String key, AttributeValue defaultValue)

public AttributeValue getAttrsOrDefault(String key, AttributeValue defaultValue)

The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

map<string, .google.cloud.visionai.v1.AttributeValue> attrs = 4;

Parameters
Name Description
key String
defaultValue AttributeValue
Returns
Type Description
AttributeValue

getAttrsOrThrow(String key)

public AttributeValue getAttrsOrThrow(String key)

The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

map<string, .google.cloud.visionai.v1.AttributeValue> attrs = 4;

Parameter
Name Description
key String
Returns
Type Description
AttributeValue

getDebugOptions()

public AnalyzerDefinition.DebugOptions getDebugOptions()

Debug options.

.google.cloud.visionai.v1.AnalyzerDefinition.DebugOptions debug_options = 5;

Returns
Type Description
AnalyzerDefinition.DebugOptions

The debugOptions.

getDebugOptionsOrBuilder()

public AnalyzerDefinition.DebugOptionsOrBuilder getDebugOptionsOrBuilder()

Debug options.

.google.cloud.visionai.v1.AnalyzerDefinition.DebugOptions debug_options = 5;

Returns
Type Description
AnalyzerDefinition.DebugOptionsOrBuilder

getDefaultInstanceForType()

public AnalyzerDefinition getDefaultInstanceForType()
Returns
Type Description
AnalyzerDefinition

getInputs(int index)

public AnalyzerDefinition.StreamInput getInputs(int index)

Input streams.

repeated .google.cloud.visionai.v1.AnalyzerDefinition.StreamInput inputs = 3;

Parameter
Name Description
index int
Returns
Type Description
AnalyzerDefinition.StreamInput

getInputsCount()

public int getInputsCount()

Input streams.

repeated .google.cloud.visionai.v1.AnalyzerDefinition.StreamInput inputs = 3;

Returns
Type Description
int

getInputsList()

public List<AnalyzerDefinition.StreamInput> getInputsList()

Input streams.

repeated .google.cloud.visionai.v1.AnalyzerDefinition.StreamInput inputs = 3;

Returns
Type Description
List<StreamInput>

getInputsOrBuilder(int index)

public AnalyzerDefinition.StreamInputOrBuilder getInputsOrBuilder(int index)

Input streams.

repeated .google.cloud.visionai.v1.AnalyzerDefinition.StreamInput inputs = 3;

Parameter
Name Description
index int
Returns
Type Description
AnalyzerDefinition.StreamInputOrBuilder

getInputsOrBuilderList()

public List<? extends AnalyzerDefinition.StreamInputOrBuilder> getInputsOrBuilderList()

Input streams.

repeated .google.cloud.visionai.v1.AnalyzerDefinition.StreamInput inputs = 3;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.AnalyzerDefinition.StreamInputOrBuilder>

getOperator()

public String getOperator()

The name of the operator that this analyzer runs.

Must match the name of a supported operator.

string operator = 2;

Returns
Type Description
String

The operator.

getOperatorBytes()

public ByteString getOperatorBytes()

The name of the operator that this analyzer runs.

Must match the name of a supported operator.

string operator = 2;

Returns
Type Description
ByteString

The bytes for operator.

getOperatorOption()

public AnalyzerDefinition.OperatorOption getOperatorOption()

Operator option.

.google.cloud.visionai.v1.AnalyzerDefinition.OperatorOption operator_option = 6;

Returns
Type Description
AnalyzerDefinition.OperatorOption

The operatorOption.

getOperatorOptionOrBuilder()

public AnalyzerDefinition.OperatorOptionOrBuilder getOperatorOptionOrBuilder()

Operator option.

.google.cloud.visionai.v1.AnalyzerDefinition.OperatorOption operator_option = 6;

Returns
Type Description
AnalyzerDefinition.OperatorOptionOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDebugOptions()

public boolean hasDebugOptions()

Debug options.

.google.cloud.visionai.v1.AnalyzerDefinition.DebugOptions debug_options = 5;

Returns
Type Description
boolean

Whether the debugOptions field is set.

hasOperatorOption()

public boolean hasOperatorOption()

Operator option.

.google.cloud.visionai.v1.AnalyzerDefinition.OperatorOption operator_option = 6;

Returns
Type Description
boolean

Whether the operatorOption 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 AnalyzerDefinition.Builder newBuilderForType()
Returns
Type Description
AnalyzerDefinition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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