Class: Google::Apis::RunV2::GoogleCloudRunV2Task

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

Overview

Task represents a single run of a container to completion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRunV2Task

Returns a new instance of GoogleCloudRunV2Task.



1984
1985
1986
 
# File 'lib/google/apis/run_v2/classes.rb', line 1984

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

KRM-style annotations for the resource. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1808
1809
1810
 
# File 'lib/google/apis/run_v2/classes.rb', line 1808

def annotations
  @annotations
end

#completion_time ⇒ String

Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations. Corresponds to the JSON property completionTime

Returns:

  • (String) 


1814
1815
1816
 
# File 'lib/google/apis/run_v2/classes.rb', line 1814

def completion_time
  @completion_time
end

#conditions ⇒ Array<Google::Apis::RunV2::GoogleCloudRunV2Condition>

Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state. Corresponds to the JSON property conditions

Returns:



1820
1821
1822
 
# File 'lib/google/apis/run_v2/classes.rb', line 1820

def conditions
  @conditions
end

#containers ⇒ Array<Google::Apis::RunV2::GoogleCloudRunV2Container>

Holds the single container that defines the unit of execution for this task. Corresponds to the JSON property containers

Returns:



1825
1826
1827
 
# File 'lib/google/apis/run_v2/classes.rb', line 1825

def containers
  @containers
end

#create_time ⇒ String

Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. Corresponds to the JSON property createTime

Returns:

  • (String) 


1832
1833
1834
 
# File 'lib/google/apis/run_v2/classes.rb', line 1832

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


1838
1839
1840
 
# File 'lib/google/apis/run_v2/classes.rb', line 1838

def delete_time
  @delete_time
end

#encryption_key ⇒ String

Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google. com/run/docs/securing/using-cmek Corresponds to the JSON property encryptionKey

Returns:

  • (String) 


1845
1846
1847
 
# File 'lib/google/apis/run_v2/classes.rb', line 1845

def encryption_key
  @encryption_key
end

#etag ⇒ String

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. Corresponds to the JSON property etag

Returns:

  • (String) 


1851
1852
1853
 
# File 'lib/google/apis/run_v2/classes.rb', line 1851

def etag
  @etag
end

#execution ⇒ String

Output only. The name of the parent Execution. Corresponds to the JSON property execution

Returns:

  • (String) 


1856
1857
1858
 
# File 'lib/google/apis/run_v2/classes.rb', line 1856

def execution
  @execution
end

#execution_environment ⇒ String

The execution environment being used to host this Task. Corresponds to the JSON property executionEnvironment

Returns:

  • (String) 


1861
1862
1863
 
# File 'lib/google/apis/run_v2/classes.rb', line 1861

def execution_environment
  @execution_environment
end

#expire_time ⇒ String

Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. Corresponds to the JSON property expireTime

Returns:

  • (String) 


1867
1868
1869
 
# File 'lib/google/apis/run_v2/classes.rb', line 1867

def expire_time
  @expire_time
end

#generation ⇒ Fixnum

Output only. A number that monotonically increases every time the user modifies the desired state. Corresponds to the JSON property generation

Returns:

  • (Fixnum) 


1873
1874
1875
 
# File 'lib/google/apis/run_v2/classes.rb', line 1873

def generation
  @generation
end

#index ⇒ Fixnum

Output only. Index of the Task, unique per execution, and beginning at 0. Corresponds to the JSON property index

Returns:

  • (Fixnum) 


1878
1879
1880
 
# File 'lib/google/apis/run_v2/classes.rb', line 1878

def index
  @index
end

#job ⇒ String

Output only. The name of the parent Job. Corresponds to the JSON property job

Returns:

  • (String) 


1883
1884
1885
 
# File 'lib/google/apis/run_v2/classes.rb', line 1883

def job
  @job
end

#labels ⇒ Hash<String,String>

KRM-style labels for the resource. User-provided labels are shared with Google' s billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https: //cloud.google.com/resource-manager/docs/creating-managing-labels or https:// cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1894
1895
1896
 
# File 'lib/google/apis/run_v2/classes.rb', line 1894

def labels
  @labels
end

#last_attempt_result ⇒ Google::Apis::RunV2::GoogleCloudRunV2TaskAttemptResult

Result of a task attempt. Corresponds to the JSON property lastAttemptResult

Returns:



1899
1900
1901
 
# File 'lib/google/apis/run_v2/classes.rb', line 1899

def last_attempt_result
  @last_attempt_result
end

#launch_stage ⇒ String

Set the launch stage to a preview stage on write to allow use of preview features in that stage. On read, describes whether the resource uses preview features. Launch Stages are defined at Google Cloud Platform Launch Stages. Corresponds to the JSON property launchStage

Returns:

  • (String) 


1907
1908
1909
 
# File 'lib/google/apis/run_v2/classes.rb', line 1907

def launch_stage
  @launch_stage
end

#max_retries ⇒ Fixnum

Number of retries allowed per Task, before marking this Task failed. Corresponds to the JSON property maxRetries

Returns:

  • (Fixnum) 


1912
1913
1914
 
# File 'lib/google/apis/run_v2/classes.rb', line 1912

def max_retries
  @max_retries
end

#name ⇒ String

Output only. The unique name of this Task. Corresponds to the JSON property name

Returns:

  • (String) 


1917
1918
1919
 
# File 'lib/google/apis/run_v2/classes.rb', line 1917

def name
  @name
end

#observed_generation ⇒ Fixnum

Output only. The generation of this Task. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property observedGeneration

Returns:

  • (Fixnum) 


1923
1924
1925
 
# File 'lib/google/apis/run_v2/classes.rb', line 1923

def observed_generation
  @observed_generation
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


1930
1931
1932
 
# File 'lib/google/apis/run_v2/classes.rb', line 1930

def reconciling
  @reconciling
end

#retried ⇒ Fixnum

Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit. Corresponds to the JSON property retried

Returns:

  • (Fixnum) 


1937
1938
1939
 
# File 'lib/google/apis/run_v2/classes.rb', line 1937

def retried
  @retried
end

#service_account ⇒ String

Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


1945
1946
1947
 
# File 'lib/google/apis/run_v2/classes.rb', line 1945

def 
  @service_account
end

#start_time ⇒ String

Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations. Corresponds to the JSON property startTime

Returns:

  • (String) 


1951
1952
1953
 
# File 'lib/google/apis/run_v2/classes.rb', line 1951

def start_time
  @start_time
end

#timeout ⇒ String

Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Corresponds to the JSON property timeout

Returns:

  • (String) 


1958
1959
1960
 
# File 'lib/google/apis/run_v2/classes.rb', line 1958

def timeout
  @timeout
end

#uid ⇒ String

Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. Corresponds to the JSON property uid

Returns:

  • (String) 


1964
1965
1966
 
# File 'lib/google/apis/run_v2/classes.rb', line 1964

def uid
  @uid
end

#update_time ⇒ String

Output only. The last-modified time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1969
1970
1971
 
# File 'lib/google/apis/run_v2/classes.rb', line 1969

def update_time
  @update_time
end

#volumes ⇒ Array<Google::Apis::RunV2::GoogleCloudRunV2Volume>

A list of Volumes to make available to containers. Corresponds to the JSON property volumes

Returns:



1974
1975
1976
 
# File 'lib/google/apis/run_v2/classes.rb', line 1974

def volumes
  @volumes
end

#vpc_access ⇒ Google::Apis::RunV2::GoogleCloudRunV2VpcAccess

VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc Corresponds to the JSON property vpcAccess

Returns:



1982
1983
1984
 
# File 'lib/google/apis/run_v2/classes.rb', line 1982

def vpc_access
  @vpc_access
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/google/apis/run_v2/classes.rb', line 1989

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @completion_time = args[:completion_time] if args.key?(:completion_time)
  @conditions = args[:conditions] if args.key?(:conditions)
  @containers = args[:containers] if args.key?(:containers)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @encryption_key = args[:encryption_key] if args.key?(:encryption_key)
  @etag = args[:etag] if args.key?(:etag)
  @execution = args[:execution] if args.key?(:execution)
  @execution_environment = args[:execution_environment] if args.key?(:execution_environment)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @generation = args[:generation] if args.key?(:generation)
  @index = args[:index] if args.key?(:index)
  @job = args[:job] if args.key?(:job)
  @labels = args[:labels] if args.key?(:labels)
  @last_attempt_result = args[:last_attempt_result] if args.key?(:last_attempt_result)
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
  @max_retries = args[:max_retries] if args.key?(:max_retries)
  @name = args[:name] if args.key?(:name)
  @observed_generation = args[:observed_generation] if args.key?(:observed_generation)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @retried = args[:retried] if args.key?(:retried)
  @service_account = args[:service_account] if args.key?(:service_account)
  @start_time = args[:start_time] if args.key?(:start_time)
  @timeout = args[:timeout] if args.key?(:timeout)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @volumes = args[:volumes] if args.key?(:volumes)
  @vpc_access = args[:vpc_access] if args.key?(:vpc_access)
end