Class Processor (0.12.0)

public final class Processor extends GeneratedMessageV3 implements ProcessorOrBuilder

Message describing Processor object. Next ID: 19

Protobuf type google.cloud.visionai.v1.Processor

Implements

ProcessorOrBuilder

Static Fields

CONFIGURATION_TYPEURL_FIELD_NUMBER

public static final int CONFIGURATION_TYPEURL_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_PROCESSOR_SOURCE_INFO_FIELD_NUMBER

public static final int CUSTOM_PROCESSOR_SOURCE_INFO_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MODEL_TYPE_FIELD_NUMBER

public static final int MODEL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROCESSOR_IO_SPEC_FIELD_NUMBER

public static final int PROCESSOR_IO_SPEC_FIELD_NUMBER
Field Value
Type Description
int

PROCESSOR_TYPE_FIELD_NUMBER

public static final int PROCESSOR_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_ANNOTATION_TYPES_FIELD_NUMBER

public static final int SUPPORTED_ANNOTATION_TYPES_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_INSTANCE_TYPES_FIELD_NUMBER

public static final int SUPPORTED_INSTANCE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTS_POST_PROCESSING_FIELD_NUMBER

public static final int SUPPORTS_POST_PROCESSING_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Processor getDefaultInstance()
Returns
Type Description
Processor

getDescriptor()

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

newBuilder()

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

newBuilder(Processor prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs.

map<string, string> labels = 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

getConfigurationTypeurl()

public String getConfigurationTypeurl()

Output only. The corresponding configuration can be used in the Application to customize the behavior of the processor.

string configuration_typeurl = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The configurationTypeurl.

getConfigurationTypeurlBytes()

public ByteString getConfigurationTypeurlBytes()

Output only. The corresponding configuration can be used in the Application to customize the behavior of the processor.

string configuration_typeurl = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for configurationTypeurl.

getCreateTime()

public Timestamp getCreateTime()

Output only. [Output only] Create timestamp.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create timestamp.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCustomProcessorSourceInfo()

public CustomProcessorSourceInfo getCustomProcessorSourceInfo()

Source info for customer created processor.

.google.cloud.visionai.v1.CustomProcessorSourceInfo custom_processor_source_info = 7;

Returns
Type Description
CustomProcessorSourceInfo

The customProcessorSourceInfo.

getCustomProcessorSourceInfoOrBuilder()

public CustomProcessorSourceInfoOrBuilder getCustomProcessorSourceInfoOrBuilder()

Source info for customer created processor.

.google.cloud.visionai.v1.CustomProcessorSourceInfo custom_processor_source_info = 7;

Returns
Type Description
CustomProcessorSourceInfoOrBuilder

getDefaultInstanceForType()

public Processor getDefaultInstanceForType()
Returns
Type Description
Processor

getDescription()

public String getDescription()

Illustrative sentences for describing the functionality of the processor.

string description = 10;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Illustrative sentences for describing the functionality of the processor.

string description = 10;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. A user friendly display name for the processor.

string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. A user friendly display name for the processor.

string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getModelType()

public ModelType getModelType()

Model Type.

.google.cloud.visionai.v1.ModelType model_type = 13;

Returns
Type Description
ModelType

The modelType.

getModelTypeValue()

public int getModelTypeValue()

Model Type.

.google.cloud.visionai.v1.ModelType model_type = 13;

Returns
Type Description
int

The enum numeric value on the wire for modelType.

getName()

public String getName()

name of resource.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

name of resource.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getProcessorIoSpec()

public ProcessorIOSpec getProcessorIoSpec()

Output only. [Output only] The input / output specifications of a processor, each type of processor has fixed input / output specs which cannot be altered by customer.

.google.cloud.visionai.v1.ProcessorIOSpec processor_io_spec = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProcessorIOSpec

The processorIoSpec.

getProcessorIoSpecOrBuilder()

public ProcessorIOSpecOrBuilder getProcessorIoSpecOrBuilder()

Output only. [Output only] The input / output specifications of a processor, each type of processor has fixed input / output specs which cannot be altered by customer.

.google.cloud.visionai.v1.ProcessorIOSpec processor_io_spec = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProcessorIOSpecOrBuilder

getProcessorType()

public Processor.ProcessorType getProcessorType()

Output only. Processor Type.

.google.cloud.visionai.v1.Processor.ProcessorType processor_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Processor.ProcessorType

The processorType.

getProcessorTypeValue()

public int getProcessorTypeValue()

Output only. Processor Type.

.google.cloud.visionai.v1.Processor.ProcessorType processor_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for processorType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Processor.ProcessorState getState()

Output only. State of the Processor.

.google.cloud.visionai.v1.Processor.ProcessorState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Processor.ProcessorState

The state.

getStateValue()

public int getStateValue()

Output only. State of the Processor.

.google.cloud.visionai.v1.Processor.ProcessorState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSupportedAnnotationTypes(int index)

public StreamAnnotationType getSupportedAnnotationTypes(int index)

repeated .google.cloud.visionai.v1.StreamAnnotationType supported_annotation_types = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
StreamAnnotationType

The supportedAnnotationTypes at the given index.

getSupportedAnnotationTypesCount()

public int getSupportedAnnotationTypesCount()

repeated .google.cloud.visionai.v1.StreamAnnotationType supported_annotation_types = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of supportedAnnotationTypes.

getSupportedAnnotationTypesList()

public List<StreamAnnotationType> getSupportedAnnotationTypesList()

repeated .google.cloud.visionai.v1.StreamAnnotationType supported_annotation_types = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<StreamAnnotationType>

A list containing the supportedAnnotationTypes.

getSupportedAnnotationTypesValue(int index)

public int getSupportedAnnotationTypesValue(int index)

repeated .google.cloud.visionai.v1.StreamAnnotationType supported_annotation_types = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of supportedAnnotationTypes at the given index.

getSupportedAnnotationTypesValueList()

public List<Integer> getSupportedAnnotationTypesValueList()

repeated .google.cloud.visionai.v1.StreamAnnotationType supported_annotation_types = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedAnnotationTypes.

getSupportedInstanceTypes(int index)

public Instance.InstanceType getSupportedInstanceTypes(int index)

Which instance types this processor supports; if empty, this default to STREAMING_PREDICTION.

repeated .google.cloud.visionai.v1.Instance.InstanceType supported_instance_types = 18;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Instance.InstanceType

The supportedInstanceTypes at the given index.

getSupportedInstanceTypesCount()

public int getSupportedInstanceTypesCount()

Which instance types this processor supports; if empty, this default to STREAMING_PREDICTION.

repeated .google.cloud.visionai.v1.Instance.InstanceType supported_instance_types = 18;

Returns
Type Description
int

The count of supportedInstanceTypes.

getSupportedInstanceTypesList()

public List<Instance.InstanceType> getSupportedInstanceTypesList()

Which instance types this processor supports; if empty, this default to STREAMING_PREDICTION.

repeated .google.cloud.visionai.v1.Instance.InstanceType supported_instance_types = 18;

Returns
Type Description
List<InstanceType>

A list containing the supportedInstanceTypes.

getSupportedInstanceTypesValue(int index)

public int getSupportedInstanceTypesValue(int index)

Which instance types this processor supports; if empty, this default to STREAMING_PREDICTION.

repeated .google.cloud.visionai.v1.Instance.InstanceType supported_instance_types = 18;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of supportedInstanceTypes at the given index.

getSupportedInstanceTypesValueList()

public List<Integer> getSupportedInstanceTypesValueList()

Which instance types this processor supports; if empty, this default to STREAMING_PREDICTION.

repeated .google.cloud.visionai.v1.Instance.InstanceType supported_instance_types = 18;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedInstanceTypes.

getSupportsPostProcessing()

public boolean getSupportsPostProcessing()

Indicates if the processor supports post processing.

bool supports_post_processing = 17;

Returns
Type Description
boolean

The supportsPostProcessing.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. [Output only] Update timestamp.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update timestamp.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. [Output only] Create timestamp.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasCustomProcessorSourceInfo()

public boolean hasCustomProcessorSourceInfo()

Source info for customer created processor.

.google.cloud.visionai.v1.CustomProcessorSourceInfo custom_processor_source_info = 7;

Returns
Type Description
boolean

Whether the customProcessorSourceInfo field is set.

hasProcessorIoSpec()

public boolean hasProcessorIoSpec()

Output only. [Output only] The input / output specifications of a processor, each type of processor has fixed input / output specs which cannot be altered by customer.

.google.cloud.visionai.v1.ProcessorIOSpec processor_io_spec = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the processorIoSpec field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. [Output only] Update timestamp.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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