Class: Google::Apis::RunV2::GoogleCloudRunV2Job

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

Job represents the configuration of a single job. A job an immutable resource that references a container image which is run to completion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRunV2Job

Returns a new instance of GoogleCloudRunV2Job.



747
748
749
 
# File 'lib/google/apis/run_v2/classes.rb', line 747

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

KRM-style annotations for the resource. 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. Cloud Run will populate some annotations using 'run.googleapis.com' or 'serving.knative.dev' namespaces. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


599
600
601
 
# File 'lib/google/apis/run_v2/classes.rb', line 599

def annotations
  @annotations
end

#binary_authorization ⇒ Google::Apis::RunV2::GoogleCloudRunV2BinaryAuthorization

Settings for Binary Authorization feature. Corresponds to the JSON property binaryAuthorization

Returns:



604
605
606
 
# File 'lib/google/apis/run_v2/classes.rb', line 604

def binary_authorization
  @binary_authorization
end

#client ⇒ String

Arbitrary identifier for the API client. Corresponds to the JSON property client

Returns:

  • (String) 


609
610
611
 
# File 'lib/google/apis/run_v2/classes.rb', line 609

def client
  @client
end

#client_version ⇒ String

Arbitrary version identifier for the API client. Corresponds to the JSON property clientVersion

Returns:

  • (String) 


614
615
616
 
# File 'lib/google/apis/run_v2/classes.rb', line 614

def client_version
  @client_version
end

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

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property conditions

Returns:



622
623
624
 
# File 'lib/google/apis/run_v2/classes.rb', line 622

def conditions
  @conditions
end

#create_time ⇒ String

Output only. The creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


627
628
629
 
# File 'lib/google/apis/run_v2/classes.rb', line 627

def create_time
  @create_time
end

#creator ⇒ String

Output only. Email address of the authenticated creator. Corresponds to the JSON property creator

Returns:

  • (String) 


632
633
634
 
# File 'lib/google/apis/run_v2/classes.rb', line 632

def creator
  @creator
end

#delete_time ⇒ String

Output only. The deletion time. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


637
638
639
 
# File 'lib/google/apis/run_v2/classes.rb', line 637

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


643
644
645
 
# File 'lib/google/apis/run_v2/classes.rb', line 643

def etag
  @etag
end

#execution_count ⇒ Fixnum

Output only. Number of executions created for this job. Corresponds to the JSON property executionCount

Returns:

  • (Fixnum) 


648
649
650
 
# File 'lib/google/apis/run_v2/classes.rb', line 648

def execution_count
  @execution_count
end

#expire_time ⇒ String

Output only. For a deleted resource, the time after which it will be permamently deleted. Corresponds to the JSON property expireTime

Returns:

  • (String) 


654
655
656
 
# File 'lib/google/apis/run_v2/classes.rb', line 654

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) 


660
661
662
 
# File 'lib/google/apis/run_v2/classes.rb', line 660

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


671
672
673
 
# File 'lib/google/apis/run_v2/classes.rb', line 671

def labels
  @labels
end

#last_modifier ⇒ String

Output only. Email address of the last authenticated modifier. Corresponds to the JSON property lastModifier

Returns:

  • (String) 


676
677
678
 
# File 'lib/google/apis/run_v2/classes.rb', line 676

def last_modifier
  @last_modifier
end

#latest_created_execution ⇒ Google::Apis::RunV2::GoogleCloudRunV2ExecutionReference

Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. Corresponds to the JSON property latestCreatedExecution

Returns:



682
683
684
 
# File 'lib/google/apis/run_v2/classes.rb', line 682

def latest_created_execution
  @latest_created_execution
end

#launch_stage ⇒ String

The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Corresponds to the JSON property launchStage

Returns:

  • (String) 


689
690
691
 
# File 'lib/google/apis/run_v2/classes.rb', line 689

def launch_stage
  @launch_stage
end

#name ⇒ String

The fully qualified name of this Job. Format: projects/project/locations/ location/jobs/job Corresponds to the JSON property name

Returns:

  • (String) 


695
696
697
 
# File 'lib/google/apis/run_v2/classes.rb', line 695

def name
  @name
end

#observed_generation ⇒ Fixnum

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

Returns:

  • (Fixnum) 


701
702
703
 
# File 'lib/google/apis/run_v2/classes.rb', line 701

def observed_generation
  @observed_generation
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observed_generation and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: observed_generation and generation, latest_succeeded_execution and latest_created_execution. If reconciliation failed, observed_generation and latest_succeeded_execution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminal_condition and conditions. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


721
722
723
 
# File 'lib/google/apis/run_v2/classes.rb', line 721

def reconciling
  @reconciling
end

#template ⇒ Google::Apis::RunV2::GoogleCloudRunV2ExecutionTemplate

ExecutionTemplate describes the data an execution should have when created from a template. Corresponds to the JSON property template

Returns:



728
729
730
 
# File 'lib/google/apis/run_v2/classes.rb', line 728

def template
  @template
end

#terminal_condition ⇒ Google::Apis::RunV2::GoogleCloudRunV2Condition

Defines a status condition for a resource. Corresponds to the JSON property terminalCondition

Returns:



733
734
735
 
# File 'lib/google/apis/run_v2/classes.rb', line 733

def terminal_condition
  @terminal_condition
end

#uid ⇒ String

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

Returns:

  • (String) 


740
741
742
 
# File 'lib/google/apis/run_v2/classes.rb', line 740

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


745
746
747
 
# File 'lib/google/apis/run_v2/classes.rb', line 745

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/google/apis/run_v2/classes.rb', line 752

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @binary_authorization = args[:binary_authorization] if args.key?(:binary_authorization)
  @client = args[:client] if args.key?(:client)
  @client_version = args[:client_version] if args.key?(:client_version)
  @conditions = args[:conditions] if args.key?(:conditions)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator = args[:creator] if args.key?(:creator)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @etag = args[:etag] if args.key?(:etag)
  @execution_count = args[:execution_count] if args.key?(:execution_count)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @generation = args[:generation] if args.key?(:generation)
  @labels = args[:labels] if args.key?(:labels)
  @last_modifier = args[:last_modifier] if args.key?(:last_modifier)
  @latest_created_execution = args[:latest_created_execution] if args.key?(:latest_created_execution)
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
  @name = args[:name] if args.key?(:name)
  @observed_generation = args[:observed_generation] if args.key?(:observed_generation)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @template = args[:template] if args.key?(:template)
  @terminal_condition = args[:terminal_condition] if args.key?(:terminal_condition)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end