Interface VertexCustomConfigOrBuilder (0.8.0)

public interface VertexCustomConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAttachApplicationMetadata()

public abstract 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 abstract 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 abstract 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

getDynamicConfigInputTopic()

public abstract 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 abstract 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 abstract 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.

getPostProcessingCloudFunction()

public abstract 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 abstract 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.

hasDedicatedResources()

public abstract 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 abstract 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.