Class: Google::Apis::CloudbuildV2::PipelineTask

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

Overview

PipelineTask defines a task in a Pipeline.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PipelineTask

Returns a new instance of PipelineTask.



1968
1969
1970
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1968

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

Instance Attribute Details

#name ⇒ String

Name of the task. Corresponds to the JSON property name

Returns:

  • (String) 


1921
1922
1923
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1921

def name
  @name
end

#params ⇒ Array<Google::Apis::CloudbuildV2::Param>

Params is a list of parameter names and values. Corresponds to the JSON property params

Returns:



1926
1927
1928
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1926

def params
  @params
end

#retries ⇒ Fixnum

Retries represents how many times this task should be retried in case of task failure. Corresponds to the JSON property retries

Returns:

  • (Fixnum) 


1932
1933
1934
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1932

def retries
  @retries
end

#run_after ⇒ Array<String>

RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.) Corresponds to the JSON property runAfter

Returns:

  • (Array<String>) 


1938
1939
1940
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1938

def run_after
  @run_after
end

#task_ref ⇒ Google::Apis::CloudbuildV2::TaskRef

TaskRef can be used to refer to a specific instance of a task. PipelineRef can be used to refer to a specific instance of a Pipeline. Corresponds to the JSON property taskRef

Returns:



1944
1945
1946
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1944

def task_ref
  @task_ref
end

#task_spec ⇒ Google::Apis::CloudbuildV2::EmbeddedTask

EmbeddedTask defines a Task that is embedded in a Pipeline. Corresponds to the JSON property taskSpec

Returns:



1949
1950
1951
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1949

def task_spec
  @task_spec
end

#timeout ⇒ String

Time after which the TaskRun times out. Defaults to 1 hour. Specified TaskRun timeout should be less than 24h. Corresponds to the JSON property timeout

Returns:

  • (String) 


1955
1956
1957
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1955

def timeout
  @timeout
end

#when_expressions ⇒ Array<Google::Apis::CloudbuildV2::WhenExpression>

Conditions that need to be true for the task to run. Corresponds to the JSON property whenExpressions

Returns:



1960
1961
1962
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1960

def when_expressions
  @when_expressions
end

#workspaces ⇒ Array<Google::Apis::CloudbuildV2::WorkspacePipelineTaskBinding>

Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task. Corresponds to the JSON property workspaces

Returns:



1966
1967
1968
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1966

def workspaces
  @workspaces
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1973

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @params = args[:params] if args.key?(:params)
  @retries = args[:retries] if args.key?(:retries)
  @run_after = args[:run_after] if args.key?(:run_after)
  @task_ref = args[:task_ref] if args.key?(:task_ref)
  @task_spec = args[:task_spec] if args.key?(:task_spec)
  @timeout = args[:timeout] if args.key?(:timeout)
  @when_expressions = args[:when_expressions] if args.key?(:when_expressions)
  @workspaces = args[:workspaces] if args.key?(:workspaces)
end