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.



2867
2868
2869
 
# File 'lib/google/apis/run_v2/classes.rb', line 2867

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


2685
2686
2687
 
# File 'lib/google/apis/run_v2/classes.rb', line 2685

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) 


2691
2692
2693
 
# File 'lib/google/apis/run_v2/classes.rb', line 2691

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:



2697
2698
2699
 
# File 'lib/google/apis/run_v2/classes.rb', line 2697

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:



2702
2703
2704
 
# File 'lib/google/apis/run_v2/classes.rb', line 2702

def containers
  @containers
end

#create_time ⇒ String

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

Returns:

  • (String) 


2708
2709
2710
 
# File 'lib/google/apis/run_v2/classes.rb', line 2708

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) 


2714
2715
2716
 
# File 'lib/google/apis/run_v2/classes.rb', line 2714

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) 


2721
2722
2723
 
# File 'lib/google/apis/run_v2/classes.rb', line 2721

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) 


2727
2728
2729
 
# File 'lib/google/apis/run_v2/classes.rb', line 2727

def etag
  @etag
end

#execution ⇒ String

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

Returns:

  • (String) 


2732
2733
2734
 
# File 'lib/google/apis/run_v2/classes.rb', line 2732

def execution
  @execution
end

#execution_environment ⇒ String

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

Returns:

  • (String) 


2737
2738
2739
 
# File 'lib/google/apis/run_v2/classes.rb', line 2737

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) 


2743
2744
2745
 
# File 'lib/google/apis/run_v2/classes.rb', line 2743

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) 


2749
2750
2751
 
# File 'lib/google/apis/run_v2/classes.rb', line 2749

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) 


2754
2755
2756
 
# File 'lib/google/apis/run_v2/classes.rb', line 2754

def index
  @index
end

#job ⇒ String

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

Returns:

  • (String) 


2759
2760
2761
 
# File 'lib/google/apis/run_v2/classes.rb', line 2759

def job
  @job
end

#labels ⇒ Hash<String,String>

Output only. Unstructured key value map that can be used to organize and categorize objects. 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 Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2769
2770
2771
 
# File 'lib/google/apis/run_v2/classes.rb', line 2769

def labels
  @labels
end

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

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

Returns:



2774
2775
2776
 
# File 'lib/google/apis/run_v2/classes.rb', line 2774

def last_attempt_result
  @last_attempt_result
end

#log_uri ⇒ String

Output only. URI where logs for this execution can be found in Cloud Console. Corresponds to the JSON property logUri

Returns:

  • (String) 


2779
2780
2781
 
# File 'lib/google/apis/run_v2/classes.rb', line 2779

def log_uri
  @log_uri
end

#max_retries ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2784
2785
2786
 
# File 'lib/google/apis/run_v2/classes.rb', line 2784

def max_retries
  @max_retries
end

#name ⇒ String

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

Returns:

  • (String) 


2789
2790
2791
 
# File 'lib/google/apis/run_v2/classes.rb', line 2789

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) 


2795
2796
2797
 
# File 'lib/google/apis/run_v2/classes.rb', line 2795

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) 


2802
2803
2804
 
# File 'lib/google/apis/run_v2/classes.rb', line 2802

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) 


2809
2810
2811
 
# File 'lib/google/apis/run_v2/classes.rb', line 2809

def retried
  @retried
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


2814
2815
2816
 
# File 'lib/google/apis/run_v2/classes.rb', line 2814

def satisfies_pzs
  @satisfies_pzs
end

#scheduled_time ⇒ String

Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations. Corresponds to the JSON property scheduledTime

Returns:

  • (String) 


2822
2823
2824
 
# File 'lib/google/apis/run_v2/classes.rb', line 2822

def scheduled_time
  @scheduled_time
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) 


2830
2831
2832
 
# File 'lib/google/apis/run_v2/classes.rb', line 2830

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) 


2836
2837
2838
 
# File 'lib/google/apis/run_v2/classes.rb', line 2836

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) 


2843
2844
2845
 
# File 'lib/google/apis/run_v2/classes.rb', line 2843

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) 


2849
2850
2851
 
# File 'lib/google/apis/run_v2/classes.rb', line 2849

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


2854
2855
2856
 
# File 'lib/google/apis/run_v2/classes.rb', line 2854

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:



2859
2860
2861
 
# File 'lib/google/apis/run_v2/classes.rb', line 2859

def volumes
  @volumes
end

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

VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. Corresponds to the JSON property vpcAccess

Returns:



2865
2866
2867
 
# File 'lib/google/apis/run_v2/classes.rb', line 2865

def vpc_access
  @vpc_access
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
 
# File 'lib/google/apis/run_v2/classes.rb', line 2872

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)
  @log_uri = args[:log_uri] if args.key?(:log_uri)
  @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)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @scheduled_time = args[:scheduled_time] if args.key?(:scheduled_time)
  @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