Class: Google::Apis::ClouddeployV1::DeployPolicy

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

Overview

A DeployPolicy resource in the Cloud Deploy API. A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DeployPolicy

Returns a new instance of DeployPolicy.



2062
2063
2064
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2062

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints:

  • Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(. ), not longer than 253 characters in total, followed by a slash (/). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/# syntax-and-character-set for more details. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1995
1996
1997
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1995

def annotations
  @annotations
end

#create_time ⇒ String

Output only. Time at which the deploy policy was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2000
2001
2002
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2000

def create_time
  @create_time
end

#description ⇒ String

Optional. Description of the DeployPolicy. Max length is 255 characters. Corresponds to the JSON property description

Returns:

  • (String) 


2005
2006
2007
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2005

def description
  @description
end

#etag ⇒ String

The weak etag of the DeployPolicy resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Corresponds to the JSON property etag

Returns:

  • (String) 


2012
2013
2014
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2012

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character.

  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2023
2024
2025
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2023

def labels
  @labels
end

#name ⇒ String

Output only. Name of the DeployPolicy. Format is projects/project/ locations/location/deployPolicies/deployPolicy`. ThedeployPolicy component must matcha-z? Corresponds to the JSON propertyname`

Returns:

  • (String) 


2030
2031
2032
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2030

def name
  @name
end

#rules ⇒ Array<Google::Apis::ClouddeployV1::PolicyRule>

Required. Rules to apply. At least one rule must be present. Corresponds to the JSON property rules

Returns:



2035
2036
2037
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2035

def rules
  @rules
end

#selectors ⇒ Array<Google::Apis::ClouddeployV1::DeployPolicyResourceSelector>

Required. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action. Corresponds to the JSON property selectors

Returns:



2043
2044
2045
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2043

def selectors
  @selectors
end

#suspended ⇒ Boolean Also known as: suspended?

Optional. When suspended, the policy will not prevent actions from occurring, even if the action violates the policy. Corresponds to the JSON property suspended

Returns:

  • (Boolean) 


2049
2050
2051
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2049

def suspended
  @suspended
end

#uid ⇒ String

Output only. Unique identifier of the DeployPolicy. Corresponds to the JSON property uid

Returns:

  • (String) 


2055
2056
2057
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2055

def uid
  @uid
end

#update_time ⇒ String

Output only. Most recent time at which the deploy policy was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2060
2061
2062
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2060

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2067

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @rules = args[:rules] if args.key?(:rules)
  @selectors = args[:selectors] if args.key?(:selectors)
  @suspended = args[:suspended] if args.key?(:suspended)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end