Class: Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoField

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/integrations_v1/classes.rb,
lib/google/apis/integrations_v1/representations.rb,
lib/google/apis/integrations_v1/representations.rb

Overview

Information about the value and type of the field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmEventbusProtoField

Returns a new instance of EnterpriseCrmEventbusProtoField.



1361
1362
1363
# File 'lib/google/apis/integrations_v1/classes.rb', line 1361

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cardinalityString

By default, if the cardinality is unspecified the field is considered required while mapping. Corresponds to the JSON property cardinality

Returns:

  • (String)


1319
1320
1321
# File 'lib/google/apis/integrations_v1/classes.rb', line 1319

def cardinality
  @cardinality
end

#default_valueGoogle::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoParameterValueType

LINT.IfChange To support various types of parameter values. Next available id: 14 Corresponds to the JSON property defaultValue



1325
1326
1327
# File 'lib/google/apis/integrations_v1/classes.rb', line 1325

def default_value
  @default_value
end

#field_typeString

Specifies the data type of the field. Corresponds to the JSON property fieldType

Returns:

  • (String)


1330
1331
1332
# File 'lib/google/apis/integrations_v1/classes.rb', line 1330

def field_type
  @field_type
end

#proto_def_pathString

Optional. The fully qualified proto name (e.g. enterprise.crm.storage.Account). Required for output field of type PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES and output field_type is PROTO_VALUE, then fully qualified proto type url should be provided to parse the input bytes. If field_type is *_ARRAY, then all the converted protos are of the same type. Corresponds to the JSON property protoDefPath

Returns:

  • (String)


1339
1340
1341
# File 'lib/google/apis/integrations_v1/classes.rb', line 1339

def proto_def_path
  @proto_def_path
end

#reference_keyString

This holds the reference key of the workflow or task parameter. 1. Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input or output parameter, for e.g. $task1_param1$. 3. Any workflow or task parameters with subfield references, for e.g., $task1_param1.employee.id$ Corresponds to the JSON property referenceKey

Returns:

  • (String)


1347
1348
1349
# File 'lib/google/apis/integrations_v1/classes.rb', line 1347

def reference_key
  @reference_key
end

#transform_expressionGoogle::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoTransformExpression

This is the transform expression to fetch the input field value. for e.g. $ param1$.CONCAT('test'). Keep points - 1. Only input field can have a transform expression. 2. If a transform expression is provided, reference_key will be ignored. 3. If no value is returned after evaluation of transform expression, default_value can be mapped if provided. 4. The field_type should be the type of the final object returned after the transform expression is evaluated. Scrubs the transform expression before logging as value provided by user so may or may not contain PII or SPII data. Corresponds to the JSON property transformExpression



1359
1360
1361
# File 'lib/google/apis/integrations_v1/classes.rb', line 1359

def transform_expression
  @transform_expression
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1366
1367
1368
1369
1370
1371
1372
1373
# File 'lib/google/apis/integrations_v1/classes.rb', line 1366

def update!(**args)
  @cardinality = args[:cardinality] if args.key?(:cardinality)
  @default_value = args[:default_value] if args.key?(:default_value)
  @field_type = args[:field_type] if args.key?(:field_type)
  @proto_def_path = args[:proto_def_path] if args.key?(:proto_def_path)
  @reference_key = args[:reference_key] if args.key?(:reference_key)
  @transform_expression = args[:transform_expression] if args.key?(:transform_expression)
end