Class: Google::Apis::WorkflowsV1::Workflow

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

Overview

Workflow program to be executed by Workflows.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Workflow

Returns a new instance of Workflow.



432
433
434
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 432

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

Instance Attribute Details

#call_log_level ⇒ String

Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence. Corresponds to the JSON property callLogLevel

Returns:

  • (String) 


348
349
350
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 348

def call_log_level
  @call_log_level
end

#create_time ⇒ String

Output only. The timestamp for when the workflow was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


353
354
355
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 353

def create_time
  @create_time
end

#crypto_key_name ⇒ String

Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/project/locations/ location/keyRings/keyRing/cryptoKeys/cryptoKey Using - as a wildcard for the project or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. Corresponds to the JSON property cryptoKeyName

Returns:

  • (String) 


363
364
365
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 363

def crypto_key_name
  @crypto_key_name
end

#description ⇒ String

Description of the workflow provided by the user. Must be at most 1000 unicode characters long. Corresponds to the JSON property description

Returns:

  • (String) 


369
370
371
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 369

def description
  @description
end

#labels ⇒ Hash<String,String>

Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


377
378
379
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 377

def labels
  @labels
end

#name ⇒ String

The resource name of the workflow. Format: projects/project/locations/ location/workflows/workflow Corresponds to the JSON property name

Returns:

  • (String) 


383
384
385
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 383

def name
  @name
end

#revision_create_time ⇒ String

Output only. The timestamp for the latest revision of the workflow's creation. Corresponds to the JSON property revisionCreateTime

Returns:

  • (String) 


388
389
390
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 388

def revision_create_time
  @revision_create_time
end

#revision_id ⇒ String

Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters. Corresponds to the JSON property revisionId

Returns:

  • (String) 


397
398
399
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 397

def revision_id
  @revision_id
end

#service_account ⇒ String

The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/project/serviceAccounts/ account or account Using - as a wildcard for the project or not providing one at all will infer the project from the account. The account value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


410
411
412
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 410

def 
  @service_account
end

#source_contents ⇒ String

Workflow code to be executed. The size limit is 128KB. Corresponds to the JSON property sourceContents

Returns:

  • (String) 


415
416
417
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 415

def source_contents
  @source_contents
end

#state ⇒ String

Output only. State of the workflow deployment. Corresponds to the JSON property state

Returns:

  • (String) 


420
421
422
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 420

def state
  @state
end

#state_error ⇒ Google::Apis::WorkflowsV1::StateError

Describes an error related to the current state of the workflow. Corresponds to the JSON property stateError

Returns:



425
426
427
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 425

def state_error
  @state_error
end

#update_time ⇒ String

Output only. The timestamp for when the workflow was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


430
431
432
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 430

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/google/apis/workflows_v1/classes.rb', line 437

def update!(**args)
  @call_log_level = args[:call_log_level] if args.key?(:call_log_level)
  @create_time = args[:create_time] if args.key?(:create_time)
  @crypto_key_name = args[:crypto_key_name] if args.key?(:crypto_key_name)
  @description = args[:description] if args.key?(:description)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @revision_create_time = args[:revision_create_time] if args.key?(:revision_create_time)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @service_account = args[:service_account] if args.key?(:service_account)
  @source_contents = args[:source_contents] if args.key?(:source_contents)
  @state = args[:state] if args.key?(:state)
  @state_error = args[:state_error] if args.key?(:state_error)
  @update_time = args[:update_time] if args.key?(:update_time)
end