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, which references a container image that is run to completion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRunV2Job

Returns a new instance of GoogleCloudRunV2Job.



998
999
1000
 
# File 'lib/google/apis/run_v2/classes.rb', line 998

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

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 API v2 does not support annotations with run. googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


838
839
840
 
# File 'lib/google/apis/run_v2/classes.rb', line 838

def annotations
  @annotations
end

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

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

Returns:



843
844
845
 
# File 'lib/google/apis/run_v2/classes.rb', line 843

def binary_authorization
  @binary_authorization
end

#client ⇒ String

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

Returns:

  • (String) 


848
849
850
 
# File 'lib/google/apis/run_v2/classes.rb', line 848

def client
  @client
end

#client_version ⇒ String

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

Returns:

  • (String) 


853
854
855
 
# File 'lib/google/apis/run_v2/classes.rb', line 853

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:



861
862
863
 
# File 'lib/google/apis/run_v2/classes.rb', line 861

def conditions
  @conditions
end

#create_time ⇒ String

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

Returns:

  • (String) 


866
867
868
 
# File 'lib/google/apis/run_v2/classes.rb', line 866

def create_time
  @create_time
end

#creator ⇒ String

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

Returns:

  • (String) 


871
872
873
 
# File 'lib/google/apis/run_v2/classes.rb', line 871

def creator
  @creator
end

#delete_time ⇒ String

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

Returns:

  • (String) 


876
877
878
 
# File 'lib/google/apis/run_v2/classes.rb', line 876

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) 


882
883
884
 
# File 'lib/google/apis/run_v2/classes.rb', line 882

def etag
  @etag
end

#execution_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


887
888
889
 
# File 'lib/google/apis/run_v2/classes.rb', line 887

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) 


893
894
895
 
# File 'lib/google/apis/run_v2/classes.rb', line 893

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) 


899
900
901
 
# File 'lib/google/apis/run_v2/classes.rb', line 899

def generation
  @generation
end

#labels ⇒ Hash<String,String>

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. Cloud Run API v2 does not support labels with run. googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


912
913
914
 
# File 'lib/google/apis/run_v2/classes.rb', line 912

def labels
  @labels
end

#last_modifier ⇒ String

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

Returns:

  • (String) 


917
918
919
 
# File 'lib/google/apis/run_v2/classes.rb', line 917

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:



923
924
925
 
# File 'lib/google/apis/run_v2/classes.rb', line 923

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. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Corresponds to the JSON property launchStage

Returns:

  • (String) 


934
935
936
 
# File 'lib/google/apis/run_v2/classes.rb', line 934

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) 


940
941
942
 
# File 'lib/google/apis/run_v2/classes.rb', line 940

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) 


946
947
948
 
# File 'lib/google/apis/run_v2/classes.rb', line 946

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) 


966
967
968
 
# File 'lib/google/apis/run_v2/classes.rb', line 966

def reconciling
  @reconciling
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


972
973
974
 
# File 'lib/google/apis/run_v2/classes.rb', line 972

def satisfies_pzs
  @satisfies_pzs
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:



979
980
981
 
# File 'lib/google/apis/run_v2/classes.rb', line 979

def template
  @template
end

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

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

Returns:



984
985
986
 
# File 'lib/google/apis/run_v2/classes.rb', line 984

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) 


991
992
993
 
# File 'lib/google/apis/run_v2/classes.rb', line 991

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


996
997
998
 
# File 'lib/google/apis/run_v2/classes.rb', line 996

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/google/apis/run_v2/classes.rb', line 1003

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