Class OperatorDefinition (0.4.0) 

public final class OperatorDefinition extends GeneratedMessageV3 implements OperatorDefinitionOrBuilder

Defines the interface of an Operator.

Arguments to an operator are input/output streams that are getting processesed/returned while attributes are fixed configuration parameters.

Protobuf type google.cloud.visionai.v1.OperatorDefinition

Inheritance

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

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

INPUT_ARGS_FIELD_NUMBER

public static final int INPUT_ARGS_FIELD_NUMBER
Field Value
Type Description
int

OPERATOR_FIELD_NUMBER

public static final int OPERATOR_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_ARGS_FIELD_NUMBER

public static final int OUTPUT_ARGS_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

SHORT_DESCRIPTION_FIELD_NUMBER

public static final int SHORT_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OperatorDefinition getDefaultInstance()
Returns
Type Description
OperatorDefinition

getDescriptor()

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

newBuilder()

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

newBuilder(OperatorDefinition prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAttributes(int index)

public OperatorDefinition.AttributeDefinition getAttributes(int index)

Declares the attributes.

repeated .google.cloud.visionai.v1.OperatorDefinition.AttributeDefinition attributes = 4;

Parameter
Name Description
index int
Returns
Type Description
OperatorDefinition.AttributeDefinition

getAttributesCount()

public int getAttributesCount()

Declares the attributes.

repeated .google.cloud.visionai.v1.OperatorDefinition.AttributeDefinition attributes = 4;

Returns
Type Description
int

getAttributesList()

public List<OperatorDefinition.AttributeDefinition> getAttributesList()

Declares the attributes.

repeated .google.cloud.visionai.v1.OperatorDefinition.AttributeDefinition attributes = 4;

Returns
Type Description
List<AttributeDefinition>

getAttributesOrBuilder(int index)

public OperatorDefinition.AttributeDefinitionOrBuilder getAttributesOrBuilder(int index)

Declares the attributes.

repeated .google.cloud.visionai.v1.OperatorDefinition.AttributeDefinition attributes = 4;

Parameter
Name Description
index int
Returns
Type Description
OperatorDefinition.AttributeDefinitionOrBuilder

getAttributesOrBuilderList()

public List<? extends OperatorDefinition.AttributeDefinitionOrBuilder> getAttributesOrBuilderList()

Declares the attributes.

repeated .google.cloud.visionai.v1.OperatorDefinition.AttributeDefinition attributes = 4;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.OperatorDefinition.AttributeDefinitionOrBuilder>

getDefaultInstanceForType()

public OperatorDefinition getDefaultInstanceForType()
Returns
Type Description
OperatorDefinition

getDescription()

public String getDescription()

Full description of the operator.

string description = 7;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Full description of the operator.

string description = 7;

Returns
Type Description
ByteString

The bytes for description.

getInputArgs(int index)

public OperatorDefinition.ArgumentDefinition getInputArgs(int index)

Declares input arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition input_args = 2;

Parameter
Name Description
index int
Returns
Type Description
OperatorDefinition.ArgumentDefinition

getInputArgsCount()

public int getInputArgsCount()

Declares input arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition input_args = 2;

Returns
Type Description
int

getInputArgsList()

public List<OperatorDefinition.ArgumentDefinition> getInputArgsList()

Declares input arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition input_args = 2;

Returns
Type Description
List<ArgumentDefinition>

getInputArgsOrBuilder(int index)

public OperatorDefinition.ArgumentDefinitionOrBuilder getInputArgsOrBuilder(int index)

Declares input arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition input_args = 2;

Parameter
Name Description
index int
Returns
Type Description
OperatorDefinition.ArgumentDefinitionOrBuilder

getInputArgsOrBuilderList()

public List<? extends OperatorDefinition.ArgumentDefinitionOrBuilder> getInputArgsOrBuilderList()

Declares input arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition input_args = 2;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinitionOrBuilder>

getOperator()

public String getOperator()

The name of this operator.

Tentatively A-Z*, e.g., BboxCounter, PetDetector, PetDetector1.

string operator = 1;

Returns
Type Description
String

The operator.

getOperatorBytes()

public ByteString getOperatorBytes()

The name of this operator.

Tentatively A-Z*, e.g., BboxCounter, PetDetector, PetDetector1.

string operator = 1;

Returns
Type Description
ByteString

The bytes for operator.

getOutputArgs(int index)

public OperatorDefinition.ArgumentDefinition getOutputArgs(int index)

Declares output arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition output_args = 3;

Parameter
Name Description
index int
Returns
Type Description
OperatorDefinition.ArgumentDefinition

getOutputArgsCount()

public int getOutputArgsCount()

Declares output arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition output_args = 3;

Returns
Type Description
int

getOutputArgsList()

public List<OperatorDefinition.ArgumentDefinition> getOutputArgsList()

Declares output arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition output_args = 3;

Returns
Type Description
List<ArgumentDefinition>

getOutputArgsOrBuilder(int index)

public OperatorDefinition.ArgumentDefinitionOrBuilder getOutputArgsOrBuilder(int index)

Declares output arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition output_args = 3;

Parameter
Name Description
index int
Returns
Type Description
OperatorDefinition.ArgumentDefinitionOrBuilder

getOutputArgsOrBuilderList()

public List<? extends OperatorDefinition.ArgumentDefinitionOrBuilder> getOutputArgsOrBuilderList()

Declares output arguments.

repeated .google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinition output_args = 3;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.OperatorDefinition.ArgumentDefinitionOrBuilder>

getParserForType()

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

getResources()

public ResourceSpecification getResources()

The resources for running the operator.

.google.cloud.visionai.v1.ResourceSpecification resources = 5;

Returns
Type Description
ResourceSpecification

The resources.

getResourcesOrBuilder()

public ResourceSpecificationOrBuilder getResourcesOrBuilder()

The resources for running the operator.

.google.cloud.visionai.v1.ResourceSpecification resources = 5;

Returns
Type Description
ResourceSpecificationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShortDescription()

public String getShortDescription()

Short description of the operator.

string short_description = 6;

Returns
Type Description
String

The shortDescription.

getShortDescriptionBytes()

public ByteString getShortDescriptionBytes()

Short description of the operator.

string short_description = 6;

Returns
Type Description
ByteString

The bytes for shortDescription.

hasResources()

public boolean hasResources()

The resources for running the operator.

.google.cloud.visionai.v1.ResourceSpecification resources = 5;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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