Class VertexCustomConfig (0.12.0)

public final class VertexCustomConfig extends GeneratedMessageV3 implements VertexCustomConfigOrBuilder

Message describing VertexCustomConfig.

Protobuf type google.cloud.visionai.v1.VertexCustomConfig

Static Fields

ATTACH_APPLICATION_METADATA_FIELD_NUMBER

public static final int ATTACH_APPLICATION_METADATA_FIELD_NUMBER
Field Value
Type Description
int

DEDICATED_RESOURCES_FIELD_NUMBER

public static final int DEDICATED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

DYNAMIC_CONFIG_INPUT_TOPIC_FIELD_NUMBER

public static final int DYNAMIC_CONFIG_INPUT_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

MAX_PREDICTION_FPS_FIELD_NUMBER

public static final int MAX_PREDICTION_FPS_FIELD_NUMBER
Field Value
Type Description
int

POST_PROCESSING_CLOUD_FUNCTION_FIELD_NUMBER

public static final int POST_PROCESSING_CLOUD_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VertexCustomConfig getDefaultInstance()
Returns
Type Description
VertexCustomConfig

getDescriptor()

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

newBuilder()

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

newBuilder(VertexCustomConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAttachApplicationMetadata()

public boolean getAttachApplicationMetadata()

If true, the prediction request received by custom model will also contain metadata with the following schema: 'appPlatformMetadata': { 'ingestionTime': DOUBLE; (UNIX timestamp) 'application': STRING; 'instanceId': STRING; 'node': STRING; 'processor': STRING; }

bool attach_application_metadata = 4;

Returns
Type Description
boolean

The attachApplicationMetadata.

getDedicatedResources()

public DedicatedResources getDedicatedResources()

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

.google.cloud.visionai.v1.DedicatedResources dedicated_resources = 2;

Returns
Type Description
DedicatedResources

The dedicatedResources.

getDedicatedResourcesOrBuilder()

public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

.google.cloud.visionai.v1.DedicatedResources dedicated_resources = 2;

Returns
Type Description
DedicatedResourcesOrBuilder

getDefaultInstanceForType()

public VertexCustomConfig getDefaultInstanceForType()
Returns
Type Description
VertexCustomConfig

getDynamicConfigInputTopic()

public String getDynamicConfigInputTopic()

Optional. By setting the configuration_input_topic, processor will subscribe to given topic, only pub/sub topic is supported now. Example channel: //pubsub.googleapis.com/projects/visionai-testing-stable/topics/test-topic message schema should be: message Message { // The ID of the stream that associates with the application instance. string stream_id = 1; // The target fps. By default, the custom processor will not send any data to the Vertex Prediction container. Note that once the dynamic_config_input_topic is set, max_prediction_fps will not work and be preceded by the fps set inside the topic. int32 fps = 2; }

optional string dynamic_config_input_topic = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The dynamicConfigInputTopic.

getDynamicConfigInputTopicBytes()

public ByteString getDynamicConfigInputTopicBytes()

Optional. By setting the configuration_input_topic, processor will subscribe to given topic, only pub/sub topic is supported now. Example channel: //pubsub.googleapis.com/projects/visionai-testing-stable/topics/test-topic message schema should be: message Message { // The ID of the stream that associates with the application instance. string stream_id = 1; // The target fps. By default, the custom processor will not send any data to the Vertex Prediction container. Note that once the dynamic_config_input_topic is set, max_prediction_fps will not work and be preceded by the fps set inside the topic. int32 fps = 2; }

optional string dynamic_config_input_topic = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for dynamicConfigInputTopic.

getMaxPredictionFps()

public int getMaxPredictionFps()

The max prediction frame per second. This attribute sets how fast the operator sends prediction requests to Vertex AI endpoint. Default value is 0, which means there is no max prediction fps limit. The operator sends prediction requests at input fps.

int32 max_prediction_fps = 1;

Returns
Type Description
int

The maxPredictionFps.

getParserForType()

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

getPostProcessingCloudFunction()

public String getPostProcessingCloudFunction()

If not empty, the prediction result will be sent to the specified cloud function for post processing.

  • The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of proto PredictResponse.
  • The cloud function should return AppPlatformCloudFunctionResponse with PredictResponse stored in the annotations field.
  • To drop the prediction output, simply clear the payload field in the returned AppPlatformCloudFunctionResponse.

string post_processing_cloud_function = 3;

Returns
Type Description
String

The postProcessingCloudFunction.

getPostProcessingCloudFunctionBytes()

public ByteString getPostProcessingCloudFunctionBytes()

If not empty, the prediction result will be sent to the specified cloud function for post processing.

  • The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of proto PredictResponse.
  • The cloud function should return AppPlatformCloudFunctionResponse with PredictResponse stored in the annotations field.
  • To drop the prediction output, simply clear the payload field in the returned AppPlatformCloudFunctionResponse.

string post_processing_cloud_function = 3;

Returns
Type Description
ByteString

The bytes for postProcessingCloudFunction.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDedicatedResources()

public boolean hasDedicatedResources()

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

.google.cloud.visionai.v1.DedicatedResources dedicated_resources = 2;

Returns
Type Description
boolean

Whether the dedicatedResources field is set.

hasDynamicConfigInputTopic()

public boolean hasDynamicConfigInputTopic()

Optional. By setting the configuration_input_topic, processor will subscribe to given topic, only pub/sub topic is supported now. Example channel: //pubsub.googleapis.com/projects/visionai-testing-stable/topics/test-topic message schema should be: message Message { // The ID of the stream that associates with the application instance. string stream_id = 1; // The target fps. By default, the custom processor will not send any data to the Vertex Prediction container. Note that once the dynamic_config_input_topic is set, max_prediction_fps will not work and be preceded by the fps set inside the topic. int32 fps = 2; }

optional string dynamic_config_input_topic = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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