Class: Google::Apis::RunV2::GoogleCloudRunOpV2Service

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

Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRunOpV2Service

Returns a new instance of GoogleCloudRunOpV2Service.



1010
1011
1012
 
# File 'lib/google/apis/run_v2/classes.rb', line 1010

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 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>) 


824
825
826
 
# File 'lib/google/apis/run_v2/classes.rb', line 824

def annotations
  @annotations
end

#binary_authorization ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2BinaryAuthorization

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

Returns:



829
830
831
 
# File 'lib/google/apis/run_v2/classes.rb', line 829

def binary_authorization
  @binary_authorization
end

#client ⇒ String

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

Returns:

  • (String) 


834
835
836
 
# File 'lib/google/apis/run_v2/classes.rb', line 834

def client
  @client
end

#client_version ⇒ String

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

Returns:

  • (String) 


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

def client_version
  @client_version
end

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

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

Returns:



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

def conditions
  @conditions
end

#create_time ⇒ String

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

Returns:

  • (String) 


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

def create_time
  @create_time
end

#creator ⇒ String

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

Returns:

  • (String) 


857
858
859
 
# File 'lib/google/apis/run_v2/classes.rb', line 857

def creator
  @creator
end

#delete_time ⇒ String

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

Returns:

  • (String) 


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

def delete_time
  @delete_time
end

#description ⇒ String

User-provided description of the Service. This field currently has a 512- character limit. Corresponds to the JSON property description

Returns:

  • (String) 


868
869
870
 
# File 'lib/google/apis/run_v2/classes.rb', line 868

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


874
875
876
 
# File 'lib/google/apis/run_v2/classes.rb', line 874

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


880
881
882
 
# File 'lib/google/apis/run_v2/classes.rb', line 880

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) 


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

def generation
  @generation
end

#ingress ⇒ String

Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Corresponds to the JSON property ingress

Returns:

  • (String) 


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

def ingress
  @ingress
end

#labels ⇒ Hash<String,String>

Map of string keys and values 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 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>) 


905
906
907
 
# File 'lib/google/apis/run_v2/classes.rb', line 905

def labels
  @labels
end

#last_modifier ⇒ String

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

Returns:

  • (String) 


910
911
912
 
# File 'lib/google/apis/run_v2/classes.rb', line 910

def last_modifier
  @last_modifier
end

#latest_created_revision ⇒ String

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property latestCreatedRevision

Returns:

  • (String) 


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

def latest_created_revision
  @latest_created_revision
end

#latest_ready_revision ⇒ String

Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property latestReadyRevision

Returns:

  • (String) 


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

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


930
931
932
 
# File 'lib/google/apis/run_v2/classes.rb', line 930

def launch_stage
  @launch_stage
end

#name ⇒ String

The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/project/locations/ location/services/service_id Corresponds to the JSON property name

Returns:

  • (String) 


938
939
940
 
# File 'lib/google/apis/run_v2/classes.rb', line 938

def name
  @name
end

#observed_generation ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def observed_generation
  @observed_generation
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, traffic_statuses, and uri 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 serving state matches the Service, 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: traffic and traffic_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision. If reconciliation failed, traffic_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created Services. 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

#template ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2RevisionTemplate

RevisionTemplate describes the data a revision should have when created from a template. Corresponds to the JSON property template

Returns:



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

def template
  @template
end

#terminal_condition ⇒ Google::Apis::RunV2::GoogleCloudRunOpV2Condition

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

Returns:



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

def terminal_condition
  @terminal_condition
end

#traffic ⇒ Array<Google::Apis::RunV2::GoogleCloudRunOpV2TrafficTarget>

Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision. Corresponds to the JSON property traffic

Returns:



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

def traffic
  @traffic
end

#traffic_statuses ⇒ Array<Google::Apis::RunV2::GoogleCloudRunOpV2TrafficTargetStatus>

Output only. Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property trafficStatuses

Returns:



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

def traffic_statuses
  @traffic_statuses
end

#uid ⇒ String

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

Returns:

  • (String) 


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

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


1003
1004
1005
 
# File 'lib/google/apis/run_v2/classes.rb', line 1003

def update_time
  @update_time
end

#uri ⇒ String

Output only. The main URI in which this Service is serving traffic. Corresponds to the JSON property uri

Returns:

  • (String) 


1008
1009
1010
 
# File 'lib/google/apis/run_v2/classes.rb', line 1008

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/google/apis/run_v2/classes.rb', line 1015

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)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @generation = args[:generation] if args.key?(:generation)
  @ingress = args[:ingress] if args.key?(:ingress)
  @labels = args[:labels] if args.key?(:labels)
  @last_modifier = args[:last_modifier] if args.key?(:last_modifier)
  @latest_created_revision = args[:latest_created_revision] if args.key?(:latest_created_revision)
  @latest_ready_revision = args[:latest_ready_revision] if args.key?(:latest_ready_revision)
  @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)
  @traffic = args[:traffic] if args.key?(:traffic)
  @traffic_statuses = args[:traffic_statuses] if args.key?(:traffic_statuses)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @uri = args[:uri] if args.key?(:uri)
end