Class Process (0.5.0)

public final class Process extends GeneratedMessageV3 implements ProcessOrBuilder

Message describing the Process object.

Protobuf type google.cloud.visionai.v1.Process

Implements

ProcessOrBuilder

Static Fields

ANALYSIS_FIELD_NUMBER

public static final int ANALYSIS_FIELD_NUMBER
Field Value
Type Description
int

ATTRIBUTE_OVERRIDES_FIELD_NUMBER

public static final int ATTRIBUTE_OVERRIDES_FIELD_NUMBER
Field Value
Type Description
int

BATCH_ID_FIELD_NUMBER

public static final int BATCH_ID_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

EVENT_ID_FIELD_NUMBER

public static final int EVENT_ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RETRY_COUNT_FIELD_NUMBER

public static final int RETRY_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RUN_MODE_FIELD_NUMBER

public static final int RUN_MODE_FIELD_NUMBER
Field Value
Type Description
int

RUN_STATUS_FIELD_NUMBER

public static final int RUN_STATUS_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 Process getDefaultInstance()
Returns
Type Description
Process

getDescriptor()

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

newBuilder()

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

newBuilder(Process prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAnalysis()

public String getAnalysis()

Required. Reference to an existing Analysis resource.

string analysis = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The analysis.

getAnalysisBytes()

public ByteString getAnalysisBytes()

Required. Reference to an existing Analysis resource.

string analysis = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for analysis.

getAttributeOverrides(int index)

public String getAttributeOverrides(int index)

Optional. Attribute overrides of the Analyzers. Format for each single override item: "{analyzer_name}:{attribute_key}={value}"

repeated string attribute_overrides = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The attributeOverrides at the given index.

getAttributeOverridesBytes(int index)

public ByteString getAttributeOverridesBytes(int index)

Optional. Attribute overrides of the Analyzers. Format for each single override item: "{analyzer_name}:{attribute_key}={value}"

repeated string attribute_overrides = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the attributeOverrides at the given index.

getAttributeOverridesCount()

public int getAttributeOverridesCount()

Optional. Attribute overrides of the Analyzers. Format for each single override item: "{analyzer_name}:{attribute_key}={value}"

repeated string attribute_overrides = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of attributeOverrides.

getAttributeOverridesList()

public ProtocolStringList getAttributeOverridesList()

Optional. Attribute overrides of the Analyzers. Format for each single override item: "{analyzer_name}:{attribute_key}={value}"

repeated string attribute_overrides = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the attributeOverrides.

getBatchId()

public String getBatchId()

Optional. Optional: Batch ID of the Process.

string batch_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The batchId.

getBatchIdBytes()

public ByteString getBatchIdBytes()

Optional. Optional: Batch ID of the Process.

string batch_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for batchId.

getCreateTime()

public Timestamp getCreateTime()

Output only. The 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. The create timestamp.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Process getDefaultInstanceForType()
Returns
Type Description
Process

getEventId()

public String getEventId()

Optional. Event ID of the input/output streams. This is useful when you have a StreamSource/StreamSink operator in the Analysis, and you want to manually specify the Event to read from/write to.

string event_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The eventId.

getEventIdBytes()

public ByteString getEventIdBytes()

Optional. Event ID of the input/output streams. This is useful when you have a StreamSource/StreamSink operator in the Analysis, and you want to manually specify the Event to read from/write to.

string event_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for eventId.

getName()

public String getName()

The name of resource.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of resource.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getRetryCount()

public int getRetryCount()

Optional. Optional: The number of retries for a process in submission mode the system should try before declaring failure. By default, no retry will be performed.

int32 retry_count = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The retryCount.

getRunMode()

public RunMode getRunMode()

Optional. Run mode of the Process.

.google.cloud.visionai.v1.RunMode run_mode = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RunMode

The runMode.

getRunModeValue()

public int getRunModeValue()

Optional. Run mode of the Process.

.google.cloud.visionai.v1.RunMode run_mode = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for runMode.

getRunStatus()

public RunStatus getRunStatus()

Optional. Status of the Process.

.google.cloud.visionai.v1.RunStatus run_status = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RunStatus

The runStatus.

getRunStatusOrBuilder()

public RunStatusOrBuilder getRunStatusOrBuilder()

Optional. Status of the Process.

.google.cloud.visionai.v1.RunStatus run_status = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RunStatusOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The 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. The update timestamp.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The create timestamp.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasRunStatus()

public boolean hasRunStatus()

Optional. Status of the Process.

.google.cloud.visionai.v1.RunStatus run_status = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the runStatus field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The 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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Process.Builder newBuilderForType()
Returns
Type Description
Process.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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