Class: Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoTaskMetadata

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

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.



3069
3070
3071
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3069

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) 


2950
2951
2952
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2950

def active_task_name
  @active_task_name
end

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

Corresponds to the JSON property admins

Returns:



2955
2956
2957
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2955

def admins
  @admins
end

#category ⇒ String

Corresponds to the JSON property category

Returns:

  • (String) 


2960
2961
2962
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2960

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) 


2965
2966
2967
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2965

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) 


2971
2972
2973
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2971

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) 


2977
2978
2979
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2977

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) 


2982
2983
2984
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2982

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) 


2988
2989
2990
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2988

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) 


2993
2994
2995
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2993

def doc_markdown
  @doc_markdown
end

#external_category ⇒ String

Corresponds to the JSON property externalCategory

Returns:

  • (String) 


2998
2999
3000
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 2998

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) 


3004
3005
3006
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3004

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) 


3009
3010
3011
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3009

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) 


3014
3015
3016
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3014

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) 


3019
3020
3021
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3019

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) 


3024
3025
3026
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3024

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) 


3031
3032
3033
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3031

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) 


3036
3037
3038
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3036

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) 


3043
3044
3045
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3043

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) 


3049
3050
3051
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3049

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) 


3055
3056
3057
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3055

def status
  @status
end

#system ⇒ String

Corresponds to the JSON property system

Returns:

  • (String) 


3060
3061
3062
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3060

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>) 


3067
3068
3069
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3067

def tags
  @tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 3074

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