Class: Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry.



5002
5003
5004
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 5002

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

Instance Attribute Details

#attributes ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoAttributes

Attributes are additional options that can be associated with each event property. For more information, see Corresponds to the JSON property attributes

Returns:



4914
4915
4916
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4914

def attributes
  @attributes
end

#children ⇒ Array<Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry>

Child parameters nested within this parameter. This field only applies to protobuf parameters Corresponds to the JSON property children

Returns:



4920
4921
4922
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4920

def children
  @children
end

#contains_large_data ⇒ Boolean Also known as: contains_large_data?

Indicates whether this variable contains large data and need to be uploaded to Cloud Storage. Corresponds to the JSON property containsLargeData

Returns:

  • (Boolean) 


4926
4927
4928
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4926

def contains_large_data
  @contains_large_data
end

#data_type ⇒ String

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

Returns:

  • (String) 


4932
4933
4934
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4932

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:



4937
4938
4939
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4937

def default_value
  @default_value
end

#description ⇒ String

Optional. The description about the parameter Corresponds to the JSON property description

Returns:

  • (String) 


4942
4943
4944
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4942

def description
  @description
end

#in_out_type ⇒ String

Specifies the input/output type for the parameter. Corresponds to the JSON property inOutType

Returns:

  • (String) 


4947
4948
4949
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4947

def in_out_type
  @in_out_type
end

#is_transient ⇒ Boolean Also known as: is_transient?

Whether this parameter is a transient parameter. Corresponds to the JSON property isTransient

Returns:

  • (Boolean) 


4952
4953
4954
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4952

def is_transient
  @is_transient
end

#json_schema ⇒ String

This schema will be used to validate runtime JSON-typed values of this parameter. Corresponds to the JSON property jsonSchema

Returns:

  • (String) 


4959
4960
4961
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4959

def json_schema
  @json_schema
end

#key ⇒ String

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

Returns:

  • (String) 


4966
4967
4968
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4966

def key
  @key
end

#name ⇒ String

The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". Corresponds to the JSON property name

Returns:

  • (String) 


4972
4973
4974
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4972

def name
  @name
end

#produced_by ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoNodeIdentifier

Represents a node identifier (type + id). Next highest id: 3 Corresponds to the JSON property producedBy

Returns:



4977
4978
4979
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4977

def produced_by
  @produced_by
end

#producer ⇒ String

Corresponds to the JSON property producer

Returns:

  • (String) 


4982
4983
4984
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4982

def producer
  @producer
end

#proto_def_name ⇒ String

The name of the protobuf type if the parameter has a protobuf data type. Corresponds to the JSON property protoDefName

Returns:

  • (String) 


4987
4988
4989
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4987

def proto_def_name
  @proto_def_name
end

#proto_def_path ⇒ String

If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". Corresponds to the JSON property protoDefPath

Returns:

  • (String) 


4994
4995
4996
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4994

def proto_def_path
  @proto_def_path
end

#required ⇒ Boolean Also known as: required?

Corresponds to the JSON property required

Returns:

  • (Boolean) 


4999
5000
5001
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4999

def required
  @required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 5007

def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @children = args[:children] if args.key?(:children)
  @contains_large_data = args[:contains_large_data] if args.key?(:contains_large_data)
  @data_type = args[:data_type] if args.key?(:data_type)
  @default_value = args[:default_value] if args.key?(:default_value)
  @description = args[:description] if args.key?(:description)
  @in_out_type = args[:in_out_type] if args.key?(:in_out_type)
  @is_transient = args[:is_transient] if args.key?(:is_transient)
  @json_schema = args[:json_schema] if args.key?(:json_schema)
  @key = args[:key] if args.key?(:key)
  @name = args[:name] if args.key?(:name)
  @produced_by = args[:produced_by] if args.key?(:produced_by)
  @producer = args[:producer] if args.key?(:producer)
  @proto_def_name = args[:proto_def_name] if args.key?(:proto_def_name)
  @proto_def_path = args[:proto_def_path] if args.key?(:proto_def_path)
  @required = args[:required] if args.key?(:required)
end