Class: Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoTaskMetadata

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

Overview

TaskMetadata are attributes that are associated to every common Task we have.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseCrmEventbusProtoTaskMetadata

Returns a new instance of EnterpriseCrmEventbusProtoTaskMetadata.



2937
2938
2939
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2937

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

Instance Attribute Details

#active_task_name ⇒ String

The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name. Corresponds to the JSON property activeTaskName

Returns:

  • (String) 


2818
2819
2820
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2818

def active_task_name
  @active_task_name
end

#admins ⇒ Array<Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoTaskMetadataAdmin>

Corresponds to the JSON property admins

Returns:



2823
2824
2825
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2823

def admins
  @admins
end

#category ⇒ String

Corresponds to the JSON property category

Returns:

  • (String) 


2828
2829
2830
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2828

def category
  @category
end

#code_search_link ⇒ String

The Code Search link to the Task Java file. Corresponds to the JSON property codeSearchLink

Returns:

  • (String) 


2833
2834
2835
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2833

def code_search_link
  @code_search_link
end

#default_json_validation_option ⇒ String

Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution. Corresponds to the JSON property defaultJsonValidationOption

Returns:

  • (String) 


2839
2840
2841
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2839

def default_json_validation_option
  @default_json_validation_option
end

#default_spec ⇒ String

Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format. Corresponds to the JSON property defaultSpec

Returns:

  • (String) 


2845
2846
2847
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2845

def default_spec
  @default_spec
end

#description ⇒ String

In a few sentences, describe the purpose and usage of the task. Corresponds to the JSON property description

Returns:

  • (String) 


2850
2851
2852
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2850

def description
  @description
end

#descriptive_name ⇒ String

The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail") Corresponds to the JSON property descriptiveName

Returns:

  • (String) 


2856
2857
2858
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2856

def descriptive_name
  @descriptive_name
end

#doc_markdown ⇒ String

Snippet of markdown documentation to embed in the RHP for this task. Corresponds to the JSON property docMarkdown

Returns:

  • (String) 


2861
2862
2863
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2861

def doc_markdown
  @doc_markdown
end

#external_category ⇒ String

Corresponds to the JSON property externalCategory

Returns:

  • (String) 


2866
2867
2868
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2866

def external_category
  @external_category
end

#external_category_sequence ⇒ Fixnum

Sequence with which the task in specific category to be displayed in task discovery panel for external users. Corresponds to the JSON property externalCategorySequence

Returns:

  • (Fixnum) 


2872
2873
2874
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2872

def external_category_sequence
  @external_category_sequence
end

#external_doc_html ⇒ String

External-facing documention embedded in the RHP for this task. Corresponds to the JSON property externalDocHtml

Returns:

  • (String) 


2877
2878
2879
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2877

def external_doc_html
  @external_doc_html
end

#external_doc_link ⇒ String

Doc link for external-facing documentation (separate from g3doc). Corresponds to the JSON property externalDocLink

Returns:

  • (String) 


2882
2883
2884
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2882

def external_doc_link
  @external_doc_link
end

#external_doc_markdown ⇒ String

DEPRECATED: Use external_doc_html. Corresponds to the JSON property externalDocMarkdown

Returns:

  • (String) 


2887
2888
2889
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2887

def external_doc_markdown
  @external_doc_markdown
end

#g3_doc_link ⇒ String

URL to the associated G3 Doc for the task if available Corresponds to the JSON property g3DocLink

Returns:

  • (String) 


2892
2893
2894
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2892

def g3_doc_link
  @g3_doc_link
end

#icon_link ⇒ String

URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. Corresponds to the JSON property iconLink

Returns:

  • (String) 


2899
2900
2901
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2899

def icon_link
  @icon_link
end

#is_deprecated ⇒ Boolean Also known as: is_deprecated?

The deprecation status of the current task. Default value is false; Corresponds to the JSON property isDeprecated

Returns:

  • (Boolean) 


2904
2905
2906
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2904

def is_deprecated
  @is_deprecated
end

#name ⇒ String

The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class. Corresponds to the JSON property name

Returns:

  • (String) 


2911
2912
2913
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2911

def name
  @name
end

#standalone_external_doc_html ⇒ String

External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html Corresponds to the JSON property standaloneExternalDocHtml

Returns:

  • (String) 


2917
2918
2919
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2917

def standalone_external_doc_html
  @standalone_external_doc_html
end

#status ⇒ String

Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE. Corresponds to the JSON property status

Returns:

  • (String) 


2923
2924
2925
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2923

def status
  @status
end

#system ⇒ String

Corresponds to the JSON property system

Returns:

  • (String) 


2928
2929
2930
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2928

def system
  @system
end

#tags ⇒ Array<String>

A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


2935
2936
2937
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2935

def tags
  @tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 2942

def update!(**args)
  @active_task_name = args[:active_task_name] if args.key?(:active_task_name)
  @admins = args[:admins] if args.key?(:admins)
  @category = args[:category] if args.key?(:category)
  @code_search_link = args[:code_search_link] if args.key?(:code_search_link)
  @default_json_validation_option = args[:default_json_validation_option] if args.key?(:default_json_validation_option)
  @default_spec = args[:default_spec] if args.key?(:default_spec)
  @description = args[:description] if args.key?(:description)
  @descriptive_name = args[:descriptive_name] if args.key?(:descriptive_name)
  @doc_markdown = args[:doc_markdown] if args.key?(:doc_markdown)
  @external_category = args[:external_category] if args.key?(:external_category)
  @external_category_sequence = args[:external_category_sequence] if args.key?(:external_category_sequence)
  @external_doc_html = args[:external_doc_html] if args.key?(:external_doc_html)
  @external_doc_link = args[:external_doc_link] if args.key?(:external_doc_link)
  @external_doc_markdown = args[:external_doc_markdown] if args.key?(:external_doc_markdown)
  @g3_doc_link = args[:g3_doc_link] if args.key?(:g3_doc_link)
  @icon_link = args[:icon_link] if args.key?(:icon_link)
  @is_deprecated = args[:is_deprecated] if args.key?(:is_deprecated)
  @name = args[:name] if args.key?(:name)
  @standalone_external_doc_html = args[:standalone_external_doc_html] if args.key?(:standalone_external_doc_html)
  @status = args[:status] if args.key?(:status)
  @system = args[:system] if args.key?(:system)
  @tags = args[:tags] if args.key?(:tags)
end