com.google.api.services.cloudresourcemanager.model

Class Constraint

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudresourcemanager.model.Constraint

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Constraint
extends GenericJson

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 administrator 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](/resource- manager/reference/rest/v1/Policy). `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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Resource Manager API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Constraint()

Method Summary

Modifier and Type	Method and Description
Constraint	clone()
BooleanConstraint	getBooleanConstraint() Defines this constraint as being a BooleanConstraint.
String	getConstraintDefault() The evaluation behavior of this constraint in the absence of 'Policy'.
String	getDescription() Detailed description of what this `Constraint` controls as well as how and where it is enforced.
String	getDisplayName() The human readable name.
ListConstraint	getListConstraint() Defines this constraint as being a ListConstraint.
String	getName() Immutable value, required to globally be unique.
Integer	getVersion() Version of the `Constraint`.
Constraint	set(String fieldName, Object value)
Constraint	setBooleanConstraint(BooleanConstraint booleanConstraint) Defines this constraint as being a BooleanConstraint.
Constraint	setConstraintDefault(String constraintDefault) The evaluation behavior of this constraint in the absence of 'Policy'.
Constraint	setDescription(String description) Detailed description of what this `Constraint` controls as well as how and where it is enforced.
Constraint	setDisplayName(String displayName) The human readable name.
Constraint	setListConstraint(ListConstraint listConstraint) Defines this constraint as being a ListConstraint.
Constraint	setName(String name) Immutable value, required to globally be unique.
Constraint	setVersion(Integer version) Version of the `Constraint`.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Constraint

public Constraint()

Method Detail

getBooleanConstraint

public BooleanConstraint getBooleanConstraint()

Defines this constraint as being a BooleanConstraint.

Returns:

value or null for none

setBooleanConstraint

public Constraint setBooleanConstraint(BooleanConstraint booleanConstraint)

Defines this constraint as being a BooleanConstraint.

Parameters:

booleanConstraint - booleanConstraint or null for none

getConstraintDefault

public String getConstraintDefault()

The evaluation behavior of this constraint in the absence of 'Policy'.

Returns:

value or null for none

setConstraintDefault

public Constraint setConstraintDefault(String constraintDefault)

The evaluation behavior of this constraint in the absence of 'Policy'.

Parameters:

constraintDefault - constraintDefault or null for none

getDescription

public String getDescription()

Detailed description of what this `Constraint` controls as well as how and where it is enforced. Mutable.

Returns:

value or null for none

setDescription

public Constraint setDescription(String description)

Detailed description of what this `Constraint` controls as well as how and where it is enforced. Mutable.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

The human readable name. Mutable.

Returns:

value or null for none

setDisplayName

public Constraint setDisplayName(String displayName)

The human readable name. Mutable.

Parameters:

displayName - displayName or null for none

getListConstraint

public ListConstraint getListConstraint()

Defines this constraint as being a ListConstraint.

Returns:

value or null for none

setListConstraint

public Constraint setListConstraint(ListConstraint listConstraint)

Defines this constraint as being a ListConstraint.

Parameters:

listConstraint - listConstraint or null for none

getName

public String getName()

Immutable value, required to globally be unique. For example, `constraints/serviceuser.services`

Returns:

value or null for none

setName

public Constraint setName(String name)

Immutable value, required to globally be unique. For example, `constraints/serviceuser.services`

Parameters:

name - name or null for none

getVersion

public Integer getVersion()

Version of the `Constraint`. Default version is 0;

Returns:

value or null for none

setVersion

public Constraint setVersion(Integer version)

Version of the `Constraint`. Default version is 0;

Parameters:

version - version or null for none

set

public Constraint set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public Constraint clone()

Overrides:

clone in class GenericJson