com.google.api.services.compute.model

Class Rule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.Rule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Rule
extends GenericJson

A rule to be applied in a Policy.

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 Compute Engine 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
Rule()

Method Summary

Modifier and Type	Method and Description
Rule	clone()
String	getAction() Required
List<Condition>	getConditions() Additional restrictions that must be met.
String	getDescription() Human-readable description of the rule.
List<String>	getIns() If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
List<LogConfig>	getLogConfigs() The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
List<String>	getNotIns() If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
List<String>	getPermissions() A permission is a string of form '..' (e.g., 'storage.buckets.list').
Rule	set(String fieldName, Object value)
Rule	setAction(String action) Required
Rule	setConditions(List<Condition> conditions) Additional restrictions that must be met.
Rule	setDescription(String description) Human-readable description of the rule.
Rule	setIns(List<String> ins) If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
Rule	setLogConfigs(List<LogConfig> logConfigs) The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
Rule	setNotIns(List<String> notIns) If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
Rule	setPermissions(List<String> permissions) A permission is a string of form '..' (e.g., 'storage.buckets.list').

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

Rule

public Rule()

Method Detail

getAction

public String getAction()

Required

Returns:

value or null for none

setAction

public Rule setAction(String action)

Required

Parameters:

action - action or null for none

getConditions

public List<Condition> getConditions()

Additional restrictions that must be met. All conditions must pass for the rule to match.

Returns:

value or null for none

setConditions

public Rule setConditions(List<Condition> conditions)

Additional restrictions that must be met. All conditions must pass for the rule to match.

Parameters:

conditions - conditions or null for none

getDescription

public String getDescription()

Human-readable description of the rule.

Returns:

value or null for none

setDescription

public Rule setDescription(String description)

Human-readable description of the rule.

Parameters:

description - description or null for none

getIns

public List<String> getIns()

If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

Returns:

value or null for none

setIns

public Rule setIns(List<String> ins)

If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

Parameters:

ins - ins or null for none

getLogConfigs

public List<LogConfig> getLogConfigs()

The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

Returns:

value or null for none

setLogConfigs

public Rule setLogConfigs(List<LogConfig> logConfigs)

The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

Parameters:

logConfigs - logConfigs or null for none

getNotIns

public List<String> getNotIns()

If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

Returns:

value or null for none

setNotIns

public Rule setNotIns(List<String> notIns)

If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

Parameters:

notIns - notIns or null for none

getPermissions

public List<String> getPermissions()

A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

Returns:

value or null for none

setPermissions

public Rule setPermissions(List<String> permissions)

A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

Parameters:

permissions - permissions or null for none

set

public Rule set(String fieldName,
                Object value)

Overrides:

set in class GenericJson

clone

public Rule clone()

Overrides:

clone in class GenericJson