Cloud PubSub V1 Client - Class MessageTransform (2.19.1)

Reference documentation and code samples for the Cloud PubSub V1 Client class MessageTransform.

All supported message transforms types.

Generated from protobuf message google.pubsub.v1.MessageTransform

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ javascript_udf
JavaScriptUDF

Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique function_name .

↳ ai_inference
AIInference

Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to.

↳ enabled
bool

Optional. This field is deprecated, use the disabled field to disable transforms.

↳ disabled
bool

Optional. If true, the transform is disabled and will not be applied to messages. Defaults to false .

getJavascriptUdf

Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique function_name .

Returns
Type
Description
JavaScriptUDF |null

hasJavascriptUdf

setJavascriptUdf

Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique function_name .

Parameter
Name
Description
var
JavaScriptUDF
Returns
Type
Description
$this

getAiInference

Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to.

Returns
Type
Description
AIInference |null

hasAiInference

setAiInference

Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to.

Parameter
Name
Description
Returns
Type
Description
$this

getEnabled

Optional. This field is deprecated, use the disabled field to disable transforms.

Returns
Type
Description
bool

setEnabled

Optional. This field is deprecated, use the disabled field to disable transforms.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getDisabled

Optional. If true, the transform is disabled and will not be applied to messages. Defaults to false .

Returns
Type
Description
bool

setDisabled

Optional. If true, the transform is disabled and will not be applied to messages. Defaults to false .

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getTransform

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: