Class: Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoParamSpecEntry

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

Key-value pair of EventBus task parameters. Next id: 13

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmFrontendsEventbusProtoParamSpecEntry

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoParamSpecEntry.



4133
4134
4135
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4133

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

Instance Attribute Details

#class_name ⇒ String

The FQCN of the Java object this represents. A string, for example, would be " java.lang.String". If this is "java.lang.Object", the parameter can be of any type. Corresponds to the JSON property className

Returns:

  • (String) 


4067
4068
4069
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4067

def class_name
  @class_name
end

#collection_element_class_name ⇒ String

If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type. Corresponds to the JSON property collectionElementClassName

Returns:

  • (String) 


4074
4075
4076
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4074

def collection_element_class_name
  @collection_element_class_name
end

#config ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoParamSpecEntryConfig

Optional fields, such as help text and other useful info. Corresponds to the JSON property config

Returns:



4079
4080
4081
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4079

def config
  @config
end

#data_type ⇒ String

The data type of the parameter. Corresponds to the JSON property dataType

Returns:

  • (String) 


4084
4085
4086
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4084

def data_type
  @data_type
end

#default_value ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoParameterValueType

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

Returns:



4089
4090
4091
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4089

def default_value
  @default_value
end

#is_deprecated ⇒ Boolean Also known as: is_deprecated?

If set, this entry is deprecated, so further use of this parameter should be prohibited. Corresponds to the JSON property isDeprecated

Returns:

  • (Boolean) 


4095
4096
4097
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4095

def is_deprecated
  @is_deprecated
end

#is_output ⇒ Boolean Also known as: is_output?

Corresponds to the JSON property isOutput

Returns:

  • (Boolean) 


4101
4102
4103
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4101

def is_output
  @is_output
end

#json_schema ⇒ String

If the data_type is JSON_VALUE, then this will define its schema. Corresponds to the JSON property jsonSchema

Returns:

  • (String) 


4107
4108
4109
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4107

def json_schema
  @json_schema
end

#key ⇒ String

Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition. Corresponds to the JSON property key

Returns:

  • (String) 


4114
4115
4116
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4114

def key
  @key
end

#proto_def ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition

Populated if this represents a proto or proto array. Corresponds to the JSON property protoDef

Returns:



4119
4120
4121
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4119

def proto_def
  @proto_def
end

#required ⇒ Boolean Also known as: required?

If set, the user must provide an input value for this parameter. Corresponds to the JSON property required

Returns:

  • (Boolean) 


4124
4125
4126
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4124

def required
  @required
end

#validation_rule ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoParamSpecEntryValidationRule

Rule used to validate inputs (individual values and collection elements) for this parameter. Corresponds to the JSON property validationRule

Returns:



4131
4132
4133
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4131

def validation_rule
  @validation_rule
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4138

def update!(**args)
  @class_name = args[:class_name] if args.key?(:class_name)
  @collection_element_class_name = args[:collection_element_class_name] if args.key?(:collection_element_class_name)
  @config = args[:config] if args.key?(:config)
  @data_type = args[:data_type] if args.key?(:data_type)
  @default_value = args[:default_value] if args.key?(:default_value)
  @is_deprecated = args[:is_deprecated] if args.key?(:is_deprecated)
  @is_output = args[:is_output] if args.key?(:is_output)
  @json_schema = args[:json_schema] if args.key?(:json_schema)
  @key = args[:key] if args.key?(:key)
  @proto_def = args[:proto_def] if args.key?(:proto_def)
  @required = args[:required] if args.key?(:required)
  @validation_rule = args[:validation_rule] if args.key?(:validation_rule)
end