Class: Google::Apis::CloudresourcemanagerV1::Constraint

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

Overview

A Constraint describes a way in which a resource's configuration can be restricted. For example, it controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization's policy adminstrator to fit the needs of the organzation by setting Policies for Constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about Policies. Constraints have a default behavior determined by the constraint_default field, which is the enforcement behavior that is used in the absence of a Policy being defined or inherited for the resource in question.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Constraint

Returns a new instance of Constraint



593
594
595
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 593

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

Instance Attribute Details

#boolean_constraint ⇒ Google::Apis::CloudresourcemanagerV1::BooleanConstraint

A Constraint that is either enforced or not. For example a constraint constraints/compute.disableSerialPortAccess. If it is enforced on a VM instance, serial port connections will not be opened to that instance. Corresponds to the JSON property booleanConstraint

Returns:



580
581
582
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 580

def boolean_constraint
  @boolean_constraint
end

#constraint_default ⇒ String

The evaluation behavior of this constraint in the absense of 'Policy'. Corresponds to the JSON property constraintDefault

Returns:

  • (String) 


585
586
587
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 585

def constraint_default
  @constraint_default
end

#description ⇒ String

Detailed description of what this Constraint controls as well as how and where it is enforced. Mutable. Corresponds to the JSON property description

Returns:

  • (String) 


572
573
574
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 572

def description
  @description
end

#display_name ⇒ String

The human readable name. Mutable. Corresponds to the JSON property displayName

Returns:

  • (String) 


565
566
567
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 565

def display_name
  @display_name
end

#list_constraint ⇒ Google::Apis::CloudresourcemanagerV1::ListConstraint

A Constraint that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a Policy. Corresponds to the JSON property listConstraint

Returns:



554
555
556
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 554

def list_constraint
  @list_constraint
end

#name ⇒ String

Immutable value, required to globally be unique. For example, constraints/serviceuser.services Corresponds to the JSON property name

Returns:

  • (String) 


591
592
593
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 591

def name
  @name
end

#version ⇒ Fixnum

Version of the Constraint. Default version is 0; Corresponds to the JSON property version

Returns:

  • (Fixnum) 


559
560
561
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 559

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



598
599
600
601
602
603
604
605
606
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 598

def update!(**args)
  @list_constraint = args[:list_constraint] if args.key?(:list_constraint)
  @version = args[:version] if args.key?(:version)
  @display_name = args[:display_name] if args.key?(:display_name)
  @description = args[:description] if args.key?(:description)
  @boolean_constraint = args[:boolean_constraint] if args.key?(:boolean_constraint)
  @constraint_default = args[:constraint_default] if args.key?(:constraint_default)
  @name = args[:name] if args.key?(:name)
end