Class: Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoAttributes

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

Attributes are additional options that can be associated with each event property. For more information, see

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmEventbusProtoAttributes

Returns a new instance of EnterpriseCrmEventbusProtoAttributes.



183
184
185
# File 'lib/google/apis/integrations_v1/classes.rb', line 183

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

Instance Attribute Details

#data_typeString

Things like URL, Email, Currency, Timestamp (rather than string, int64...) Corresponds to the JSON property dataType

Returns:

  • (String)


132
133
134
# File 'lib/google/apis/integrations_v1/classes.rb', line 132

def data_type
  @data_type
end

#default_valueGoogle::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoValueType

Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. Corresponds to the JSON property defaultValue



138
139
140
# File 'lib/google/apis/integrations_v1/classes.rb', line 138

def default_value
  @default_value
end

#is_requiredBoolean Also known as: is_required?

Required for event execution. The validation will be done by the event bus when the event is triggered. Corresponds to the JSON property isRequired

Returns:

  • (Boolean)


144
145
146
# File 'lib/google/apis/integrations_v1/classes.rb', line 144

def is_required
  @is_required
end

#is_searchableBoolean Also known as: is_searchable?

Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. Corresponds to the JSON property isSearchable

Returns:

  • (Boolean)


151
152
153
# File 'lib/google/apis/integrations_v1/classes.rb', line 151

def is_searchable
  @is_searchable
end

#log_settingsGoogle::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoLogSettings

The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. Corresponds to the JSON property logSettings



159
160
161
# File 'lib/google/apis/integrations_v1/classes.rb', line 159

def log_settings
  @log_settings
end

#maskedBoolean Also known as: masked?

True if this workflow parameter should be masked in the logs Corresponds to the JSON property masked

Returns:

  • (Boolean)


164
165
166
# File 'lib/google/apis/integrations_v1/classes.rb', line 164

def masked
  @masked
end

#read_onlyBoolean Also known as: read_only?

Used to indicate if the ParameterEntry is a read only field or not. Corresponds to the JSON property readOnly

Returns:

  • (Boolean)


170
171
172
# File 'lib/google/apis/integrations_v1/classes.rb', line 170

def read_only
  @read_only
end

#searchableString

Corresponds to the JSON property searchable

Returns:

  • (String)


176
177
178
# File 'lib/google/apis/integrations_v1/classes.rb', line 176

def searchable
  @searchable
end

#task_visibilityArray<String>

List of tasks that can view this property, if empty then all. Corresponds to the JSON property taskVisibility

Returns:

  • (Array<String>)


181
182
183
# File 'lib/google/apis/integrations_v1/classes.rb', line 181

def task_visibility
  @task_visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



188
189
190
191
192
193
194
195
196
197
198
# File 'lib/google/apis/integrations_v1/classes.rb', line 188

def update!(**args)
  @data_type = args[:data_type] if args.key?(:data_type)
  @default_value = args[:default_value] if args.key?(:default_value)
  @is_required = args[:is_required] if args.key?(:is_required)
  @is_searchable = args[:is_searchable] if args.key?(:is_searchable)
  @log_settings = args[:log_settings] if args.key?(:log_settings)
  @masked = args[:masked] if args.key?(:masked)
  @read_only = args[:read_only] if args.key?(:read_only)
  @searchable = args[:searchable] if args.key?(:searchable)
  @task_visibility = args[:task_visibility] if args.key?(:task_visibility)
end